Skip to main content
The record’s status field reflects the stage of the employee’s employment cycle. The values are the EmployeeStatus enum. Handle it robustly against unknown values: the set may grow additively.

​
EmployeeStatus values

The internal statuses CREATED (a hire draft) and DELETED are never returned through the Developer API — they are filtered out of every read. You will not encounter them in responses.

The typical path of a record: hire → work → leave/hold → termination

The diagram shows the typical movement, not a strict state machine. Do not rely on a specific order of transitions — go by the current status value.

​
Filtering by status

The list is filtered with the status parameter. For multiple values repeat the parameter — a comma does not separate them:
An unknown value in status gives DEVELOPER.INVALID_STATUS.
status is an employment status, not the state of an account in the application. An employee in EMPLOYEE_STATUS_ACTIVE may have been invited to the application but not yet accepted the invitation. The API does not surface this distinction, and the status filter will not separate such employees out — do not read ACTIVE as “uses the application.”

​
Next

Employee model

Record fields and the access model.

Employee graph

Employee relationships and traversal via expand.

Webhooks

React to changes without polling.