Skip to main content
GET
List departments

Authorizations

Authorization
string
header
required

API key — tb_live_… for production data, tb_test_… for the sandbox.

Query Parameters

cursor
string

The pagination.next_cursor of the previous page. Omit it, or send it empty, for the first page. A cursor is opaque and works only on the endpoint that returned it, for the same company.

Maximum string length: 512
Example:

"djEuQ2hhY2hhMjAuZXhhbXBsZS1jdXJzb3I"

limit
integer
default:25

How many items to return per page, from 1 to 100.

Required range: 1 <= x <= 100
Example:

25

include_archived
boolean
default:false

Set to true to include archived departments. They are left out by default.

Example:

false

Response

A page of departments.

data
object[]
required

Departments on this page, oldest first.

pagination
object
required

Where the next page starts.