Lists all employees in the authenticated caller's company as a cursor-paginated employee directory. Use this to list employees, browse the company directory, fetch the employee roster, or batch-lookup multiple employees by ID. The response is a JSON object with data (an array of employee records), meta.total (count of all employees matching the filter, not just the current page), meta.page (cursor pagination state), and _links (self, plus next / prev when more pages exist). Each employee record always includes the default identity and job fields, plus any additional fields requested via fields. employeeId is returned as a string and is the internal employee ID — see the employeeId and employeeNumber field documentation in the response schema for the distinction between the internal ID and the editable Employee # value. Field values the caller cannot read are returned as null, and the names of those suppressed fields are listed on the record in _restrictedFields; if the caller cannot read a field used in filter or sort, the affected employee is dropped from the result set entirely to avoid leaking presence. IDs for filter[ids] come from prior responses of this endpoint. For a single employee with the full set of fields, use get-employee. For complex filtering, arbitrary sorting, or tabular reports across many fields, use Get Data from Dataset (v2) (get-data-from-dataset-v2).
OAuth Scopes: employee, employee:job, employee:name, employee_directory, sensitive_employee:protected_info
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
401Unauthorized.
429Too many requests.
500Internal server error.
