List Employees
Returns employees of the key’s tenant, newest first. Draft (CREATED) and
deleted employees are never returned. Related objects are included only
when requested via expand.
Required scope: employees:read
Error Codes:
- INTEGRATION.API_KEY_INVALID: The API key is missing, inactive, expired, or unknown.
- DEVELOPER.SCOPE_INSUFFICIENT: The key lacks the employees:read scope.
- INVALID_ARGUMENT: An unknown filter/expand value or a malformed page_token.
Авторизации
Параметры запроса
Maximum employees to return. Default 100, capped at 1000.
Opaque continuation token from a previous response. Bound to the filter set; reusing it with different filters is rejected with INVALID_ARGUMENT.
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 Restrict to these department ids (repeat for multiple values).
Only employees whose card changed at or after this instant. Does not cover renames of related objects (person, department) or hierarchy moves.
Related objects to include: person, department, job_title, manager.
Compute total_count. Off by default because it adds a COUNT per page and is only an estimate above ~10k rows.