Skip to main content
GET
List employees
Building profile widgets? See Employee widgets for lookup patterns and how to treat employees who have not signed in yet.

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

email
string

Only the employee with this email address. Matching ignores case.

Maximum string length: 256
Example:

"nino.beridze@example.com"

external_id
string

Only the employee with this key from your HR system. Matching is exact.

Maximum string length: 255
Example:

"EMP-00042"

department_id
string<uuid>

Only members of this department. Members of its sub-departments are not included.

Example:

"b3e1f7a2-6c4d-4e8f-9a1b-2c3d4e5f6a7b"

Response

A page of employees.

data
object[]
required

Employees on this page, in the order they joined.

pagination
object
required

Where the next page starts.