List Employees

Returns a cursor-paginated collection of employees for the authenticated caller's company, with optional filtering and sorting. Each record contains a fixed set of identity and job fields (employeeId, firstName, lastName, preferredName, photoUrl, jobTitleName, status) plus any additional fields requested via fields; values the caller cannot see are returned as null and their field names are listed in _restrictedFields. Use filter[ids] to batch-fetch specific employees (IDs are obtained from prior responses of this endpoint or the Employee Directory), filter[firstName] / filter[lastName] / filter[jobTitleName] for case-insensitive substring matches, and filter[status] (active or inactive) to narrow by status. Prefer this endpoint for lightweight directory-style listings and batch lookups; for the full set of fields on a single employee use Get Employee, and for tabular reporting across many custom fields use the Datasets API.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
filter
object

Filters used to match employees. Encode filter properties using deepObject style. If the caller does not have access to the filtered field on a matching employee, that employee is excluded from the results to avoid leaking sensitive data.

string

Comma-separated list of sortable fields. Prefix a field with "-" for descending order. Allowed fields: employeeId, firstName, lastName, preferredName, jobTitleName, status. Nulls sort first in ascending order and last in descending order. If the caller does not have access to the sort field for an employee, that employee is excluded from the final result set to avoid leaking sensitive information.

fields
array of objects

Comma-separated list of additional fields to include in the response beyond the default set. Unrecognized field names are silently ignored. Field values are subject to permission checks — restricted fields will be null and their names are listed in _restrictedFields.

fields
page
object

Cursor-based pagination parameters (limit, after, before).

Responses

401

Unauthorized.

429

Too many requests.

500

Internal server error.

Language
Credentials
At least 1 scope group required
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json