v1

latestOpenAPI 3.1.02026-07-2421872196.9 KB
Employees

List employees

Returns a list of employees.

get/employees

Query parameters

ids[]integer

Fitler people by IDs. Multiple IDs can be provided using an ampersand separated list. For example, ids[]=1&ids[]=2

emails[]string

Filter people by emails. Multiple emails can be provided using an ampersand separated list. For example, emails[]=abc@gmail.com&emails[]=def@gmail.com

employee_numbers[]string

Filter people by employee numbers. Multiple employee_numbers can be provided using an ampersand separated list. For example, employee_numbers[]=E001&employee_numbers[]=E002

status'active' | 'all' | 'employed' | 'terminated' | 'hired' | 'probation'

Filter people by status.

pageinteger

A cursor for pagination across multiple pages of results.

hired_on[gte]string date
Example:2023-01-01

Filter people hired on or before this value.

hired_on[lte]string date
Example:2023-01-01

Filter people hired on or after this value.

manager_idinteger

Filter people by their manager ID

created_at[gte]string

Filter employees created on or after this value.

created_at[lte]string

Filter employees created on or before this value.

updated_at[gte]string

Filter employees updated on or after this value.

updated_at[lte]string

Filter employees updated on or before this value.

Response

OK

All 218 operations