Relesys API Docs

v1.3

https://api.uat.relesystest.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests Permissions Notifications Markdown Syntax Module Settings

Endpoints

Users

Get User
GET /users/{userId} 
https://api.uat.relesystest.net/api/v1.3/users/{userId}
Get a single user object based on their ID
Scopes: relesys.api, relesys.api:read, relesys.api.users, relesys.api.users:read
URL Path
userId string / guid The user's unique identifier required
Responses
application/json
200
Schema Example
JSON
{"data":{"id":"1a67a702-3043-401d-b435-353531cf57a8","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-01-13T14:58:54.8305671Z","lastModifiedDateTime":"2026-01-13T14:58:54.8305671Z","externalId":"NUA","name":"New User A","userName":"UserNameA","title":"User Title A","dataSource":"RelesysAPI","email":"personalmaila@testmail.com","secondaryEmail":"businessmaila@testmail.com","phoneNumber":{"countryCode":45,"number":"12345678"},"secondaryPhoneNumber":{"countryCode":45,"number":"12345679"},"birthDate":"2002-12-30T00:00:00Z","primaryDepartmentId":"b91c7223-7ba8-4e20-b523-cc3eba2cf1dc","additionalDepartments":[{"id":"d23fa494-0417-4ca8-b3d4-5d491fe0238c","dataSource":"RelesysAPI"}],"userGroups":[{"id":"8d71d106-f108-4fab-b975-9df309c3b8db","dataSource":"RelesysAPI"},{"id":"534b6a45-45d8-488d-95cb-99caa64f198f","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2"},"employmentType":"Full-time employee"}}
object
  ⯈ data object      
   ⯈ additionalDepartments array[object]      
    dataSource string      
    id string / guid      
   birthDate datetime      
   customFields dictionary`2      
   dataSource string      
   departmentUrl string      
   email string      
   employmentDate datetime      
   employmentEndDate datetime      
   employmentType string      
   externalId string      
   id string / guid      
   name string      
   ⯈ phoneNumber object      
    countryCode integer      
    number string      
   primaryDepartmentId string / guid      
   secondaryEmail string      
   ⯈ secondaryPhoneNumber object      
    countryCode integer      
    number string      
   status string      
   title string      
   url string      
   ⯈ userGroups array[object]      
    dataSource string      
    id string / guid      
   userName string