Relesys API Docs

v1.2

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

Welcome

Introduction Getting access

Concepts

Scopes HTTP Status Codes Request Throttling Pagination Filtering Sorting Patch Requests

Endpoints

Users

Get Users
GET /users 
https://api.relesysapp.net/api/v1.2/users
Get all users - Can be filtered by the listed properties.
Scopes: relesys.api, relesys.api:read, relesys.api.users, relesys.api.users:read
Query String
birthDate datetime Filterable Sortable optional
creationDateTime datetime Filterable Sortable optional
dataSource string Filterable Sortable optional
email string Filterable Sortable optional
employmentDate datetime Filterable Sortable optional
employmentEndDate datetime Filterable Sortable optional
externalId string Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetime Filterable Sortable optional
name string Filterable Sortable optional
primaryDepartmentId string / guid Filterable optional
secondaryEmail string Filterable Sortable optional
status string Filterable Sortable optional
title string Filterable Sortable optional
userName string Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"b495f6cf-78cc-460f-811f-92854f4c4f2f","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2024-04-18T23:36:45.2535004Z","lastModifiedDateTime":"2024-04-18T23:36:45.2535004Z","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":"fbb4fca3-1390-418a-8dee-59fcd7b46f86","additionalDepartments":[{"id":"0324abfd-657c-4d21-8d5a-e7628c86bdca","dataSource":"RelesysAPI"}],"userGroups":[{"id":"fdbb12f6-b5e0-4d59-8fdc-05aa39766bb5","dataSource":"RelesysAPI"},{"id":"65f6af9c-3b54-4400-a495-e08025ce6db2","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{"customfieldone":"Custom field 1","customfieldtwo":"Custom field 2","customfieldthree":"Custom field 3"}},{"id":"e88ced23-fb97-4039-922f-42d2494efacc","url":null,"departmentUrl":null,"status":"Activated","creationDateTime":"2024-04-18T23:36:45.2535004Z","lastModifiedDateTime":"2024-04-18T23:36:45.2535004Z","externalId":"NUB","name":"New User B","userName":"UserNameB","title":"User Title","dataSource":"RelesysAPI","email":"personalmailb@testmail.com","secondaryEmail":"businessmailb@testmail.com","phoneNumber":{"countryCode":45,"number":"12345678"},"secondaryPhoneNumber":{"countryCode":45,"number":"12345679"},"birthDate":"2001-12-30T00:00:00Z","primaryDepartmentId":"b94ec04a-9fb1-49c5-9a7e-ad40bc2c4326","additionalDepartments":[{"id":"ef1fcbb4-df16-456c-b59c-39b71a8fa29a","dataSource":"RelesysAPI"}],"userGroups":[{"id":"4c7a4715-e1f0-4041-987c-542421195ca2","dataSource":"RelesysAPI"},{"id":"1c8cdc30-2e74-437f-8a98-b6e3ec625374","dataSource":"RelesysAPI"}],"employmentDate":"2018-12-30T13:30:00Z","employmentEndDate":"2021-12-30T13:30:00Z","customFields":{}}]}
object
  count integer      
  ⯈ data array[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      
  nextUrl string      
  previousUrl string