Skip to main content
GET
List Employees

Авторизации

X-API-Key
string
header
обязательно

Параметры запроса

limit
integer<int32>

Maximum employees to return. Default 100, capped at 1000.

page_token
string

Opaque continuation token from a previous response. Bound to the filter set; reusing it with different filters is rejected with INVALID_ARGUMENT.

status
enum<string>[]

Restrict to these statuses (repeat the parameter for multiple values).

Доступные опции:
EMPLOYEE_STATUS_UNSPECIFIED,
EMPLOYEE_STATUS_HIRED,
EMPLOYEE_STATUS_ACCEPTED,
EMPLOYEE_STATUS_ONBOARDING,
EMPLOYEE_STATUS_ACTIVE,
EMPLOYEE_STATUS_TERMINATED,
EMPLOYEE_STATUS_LEAVE,
EMPLOYEE_STATUS_ON_HOLD
department_id
string[]

Restrict to these department ids (repeat for multiple values).

updated_since
string<date-time>

Only employees whose card changed at or after this instant. Does not cover renames of related objects (person, department) or hierarchy moves.

expand
string[]

Related objects to include: person, department, job_title, manager.

include_total
boolean

Compute total_count. Off by default because it adds a COUNT per page and is only an estimate above ~10k rows.

Ответ

OK

employees
object[]
read-only

The page of employees, newest first.

next_page_token
string
read-only

Continuation token for the next page; empty when there are no more results.

total_count
string
read-only

Total matching employees; present only when include_total was set. Approximate above ~10k rows.