Skip to navigation
API ReferenceCompany

List Departments

Returns your company’s departments, as an id and name for each, in alphabetical order. Deleted departments are not returned.

Use the id values for the departments filter of List Staff and List Inactive Staff.

Authentication

AuthorizationApi-Key

Format: “Api-Key {api-key}”

Query parameters

pageintegerOptional
Page number, starting at 1.
page_sizeintegerOptional
Results per page. Default and maximum 500.

Response

messagestring
statusboolean
datalist of objects
countinteger
Total number of departments.
prevstring or null

URL of the previous page, or null on the first page.

nextstring or null

URL of the next page, or null on the last page.