Relesys API Docs

v1.3

https://api.relesysapp.net/api/v1.3

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Users

Get User
GET /users/{userId} 
https://api.relesysapp.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":"fd5631ad-1d67-4e40-af8e-34264883824a","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2025-04-25T09:15:46.6437017Z","lastModifiedDateTime":"2025-04-25T09:15:46.6437017Z","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":"4e5dc390-fb1d-4011-b22a-fd5acf7e0e7e","additionalDepartments":[{"id":"28c9dd79-f568-48a9-befd-fca717d06b93","dataSource":"RelesysAPI"}],"userGroups":[{"id":"78d8d7ca-6167-408c-a495-4d5958f6f00f","dataSource":"RelesysAPI"},{"id":"8567e018-d5e3-423a-85d1-e491b3aa38e2","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2"}}}
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      
   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