Connector API
Search…
Departments

Get all departments

Returns all departments of an enterprise associated with the connector integration.

Request

[PlatformAddress]/api/connector/v1/departments/getAll
1
{
2
"ClientToken": "E0D439EE522F44368DC78E1BFB03710C-D24FB11DBE31D4621C4817E028D9E1D",
3
"AccessToken": "C66EF7B239D24632943D115EDE9CB810-EA00F8FD8294692C940F6B5A8F9453D",
4
"Client": "Sample Client 1.0.0"
5
}
Copied!
Property
Type
Contract
Description
ClientToken
string
required
Token identifying the client application.
AccessToken
string
required
Access token of the client application.
Client
string
required
Name and version of the client application.

Response

1
{
2
"Departments": [
3
{
4
"Id": "98776d06-60e4-495f-82f1-95ab2f644d63",
5
"IsActive": true,
6
"Name": "Sales"
7
},
8
{
9
"Id": "915fbb82-de35-48a0-9e9b-f4a7eac711bb",
10
"IsActive": true,
11
"Name": "Housekeeping"
12
}
13
]
14
}
Copied!
Property
Type
Contract
Description
Departments
array of Department
required
The departments of the enterprise.

Department

Property
Type
Contract
Description
Id
string
required
Unique identifier of the department.
IsActive
boolean
required
Whether the department is still active.
Name
string
required
Name of the department.
Last modified 3mo ago