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

Departments

Get Departments
GET /departments 
https://api.relesysapp.net/api/v1.3/departments
Get all departments - Possible to filter based on the shown properties.

Default sort is by name in ascending order.
Scopes: relesys.api, relesys.api:read, relesys.api.users, relesys.api.users:read
Query String
addressLine string Filterable Sortable optional
addressLine2 string Filterable Sortable optional
city string Filterable Sortable optional
contentCulture string Filterable Sortable optional
creationDateTime datetime Filterable Sortable optional
defaultPhoneCountryCode integer Filterable Sortable optional
email string Filterable Sortable optional
externalId string Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetime Filterable Sortable optional
managerUserId string / guid Filterable Sortable optional
name string Filterable Sortable optional
parentId string / guid Filterable optional
showDepartmentManagerPublic boolean Filterable optional
showEmployeeList boolean Filterable optional
showInContacts boolean Filterable optional
timeZone string Filterable Sortable optional
type string Filterable Sortable optional
uiCulture string Filterable Sortable optional
userLanguageEnabled boolean Filterable optional
zipCode 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 100) Default: 100 optional
Responses
application/json
200
Schema Example
JSON
{"count":2,"data":[{"id":"a009a0fa-ff1d-44d5-9bd7-97c4d1434309","url":null,"creationDateTime":"2024-11-21T06:21:09.5213982Z","lastModifiedDateTime":"2024-11-21T06:21:09.5213982Z","name":"Relesys Main HQ","parentId":"e53c286b-c7ff-461c-a570-52d087bbfcf2","externalId":"HQ","addressLine":"Relesys Road 10","addressLine2":"2nd floor","zipCode":"2920","city":"Relecity","defaultPhoneCountryCode":45,"phoneNumber":{"countryCode":45,"number":"12345678"},"managerUserId":"08708795-6f9b-48e1-a5c6-402d3b5f890b","showInContacts":true,"showInHighscores":true,"showInActivityStatistics":true,"contentCulture":"da-dk","uiCulture":"da-dk","type":"Company","timeZone":"UTC","email":"Test@test.com","userLanguageEnabled":false,"selectedCultures":null,"showDepartmentManagerPublic":false,"showEmployeeList":true,"showDepartmentInTaggingOverview":true,"showUsersInTaggingOverview":true,"locales":[]},{"id":"c3839251-c917-491a-80f0-935a1120029c","url":null,"creationDateTime":"2024-11-21T06:21:09.5213982Z","lastModifiedDateTime":"2024-11-21T06:21:09.5213982Z","name":"Relesys Admin HQ","parentId":"ebc454ed-4910-475d-ac75-552f980db03d","externalId":"Administration","addressLine":"Relesys Road 10","addressLine2":"3rd floor","zipCode":"2920","city":"Relecity","defaultPhoneCountryCode":null,"phoneNumber":{"countryCode":45,"number":"12345678"},"managerUserId":"9559144c-7d72-4a9b-bc17-592b50d333be","showInContacts":true,"showInHighscores":true,"showInActivityStatistics":true,"contentCulture":"da-dk","uiCulture":"da-dk","type":"Region","timeZone":"UTC","email":"Test@test.com","userLanguageEnabled":true,"selectedCultures":["en-GK"],"showDepartmentManagerPublic":false,"showEmployeeList":false,"showDepartmentInTaggingOverview":true,"showUsersInTaggingOverview":false,"locales":[{"culture":"en-GB","description":"Example description"}]}]}
object
  count integer      
  ⯈ data array[object]      
   addressLine string      
   addressLine2 string      
   city string      
   contentCulture string      
   creationDateTime datetime      
   defaultPhoneCountryCode integer      
   email string      
   externalId string      
   id string / guid      
   lastModifiedDateTime datetime      
   ⯈ locales array[object]      
    culture string      
    description string      
   managerUserId string / guid      
   name string      
   parentId string / guid      
   ⯈ phoneNumber object      
    countryCode integer      
    number string      
   selectedCultures array[string]      
   showDepartmentInTaggingOverview boolean      
   showDepartmentManagerPublic boolean      
   showEmployeeList boolean      
   showInActivityStatistics boolean      
   showInContacts boolean      
   showInHighscores boolean      
   showUsersInTaggingOverview boolean      
   timeZone string      
   type string      
   uiCulture string      
   url string      
   userLanguageEnabled boolean      
   zipCode string      
  nextUrl string      
  previousUrl string