Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Department & Team

department.list

Lists all departments.

See the Pagination and Incremental Synchronization guide for detailed usage examples.

Requires the organizationRead permission.

post/department.list

Request body

includeArchivedboolean nullable

Whether archived departments should be included in the response

cursorstring nullable

The pagination cursor. Use 'start' for the first page or the nextCursor value from a previous response.

limitinteger nullable

The maximum number of departments to return per page. Maximum is 100.

syncTokenstring nullable

A sync token to retrieve only departments updated since the last sync. Obtained from a previous list response.

Example request

{
  "cursor": "G8",
  "limit": 25,
  "syncToken": "jYnEBmjzR"
}

Response

Responses from the department.list endpoint

OR

Example response

{
  "success": true,
  "results": [
    {
      "id": "3ae2b801-19f6-41ef-ad28-214bd731948f",
      "name": "Engineering Operations",
      "externalName": "Engineering",
      "isArchived": false,
      "parentId": null,
      "createdAt": "2024-01-01T00:00:00.000Z",
      "updatedAt": "2024-01-01T00:00:00.000Z",
      "extraData": null
    }
  ],
  "moreDataAvailable": false,
  "syncToken": "sync-token-example"
}