Skip to main content
GET
Filter all employees

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page_size
integer

The max size of each page of results

offset
integer

The integer offset at which to start the page. Possible values are 0 to total_records - 1

first_name
string

The employee first name for which you would like to filter

last_name
string

The employee last name for which you would like to filter

name
string

The employee's name for which you would like to filter

date_of_birth
string

The ISO-8601 (YYYY-MM-DD) employee date of birth for which you would like to filter

employment_status
string

Status of the employees employment

person_id
string

Filter employees by Person ID

group_id
string<uuid>

Filter employees by Group ID

Example:

"4613a221-d3c8-4c8a-86d5-e7e885fd1da9"

Response

200 - application/json

Successful Response - Returns all matching Employees

meta
object
required

Metadata associated with the response data

response
object[]
required

List of employee results