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 Permissions Notifications Markdown Syntax Module Settings Recurrence Rules

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":"f3402fa0-99f8-45d6-a031-2c14e9af0b9d","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2026-02-18T16:00:15.3147707Z","lastModifiedDateTime":"2026-02-18T16:00:15.3147707Z","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":"c019080e-f338-4cda-a8e0-143d01feae1f","additionalDepartments":[{"id":"b8cd161c-f0ca-4884-a2d6-3ea2e5b1aacd","dataSource":"RelesysAPI"}],"userGroups":[{"id":"7abd9279-ad9b-43be-85cc-315456ef098c","dataSource":"RelesysAPI"},{"id":"bf86f404-4811-4ed8-a51a-9cfde59d019a","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