Skip to main content
GET
List employees

Authorizations

Authorization
string
header
required

Access token from POST /oauth/token.

Query Parameters

status
enum<string>

Employment status. Defaults to ACTIVE.

Available options:
ACTIVE,
TERMINATED
group
string

Group names, comma-separated, case-insensitive. An unknown name returns an empty page.

groupId
string

Group ids from GET /v1/groups, comma-separated.

email
string

One email address, case-insensitive.

onboardingStatus
string

Onboarding statuses, comma-separated: COMPLETE, INCOMPLETE, ONGOING or NOT_APPLICABLE.

pageSize
integer<int32>

Results per page, 1-100. Defaults to 25.

pageCursor
string

The startCursor or endCursor from a previous page of this list. Send the same filters as on that page. Leave it out for the first page.

Response

Employees returned.

A page of results.

pageInfo
object

Pagination details.

results
object[]

The results on this page.