List employees

get

https://app.peopleforce.io/api/public/v3/employees

Returns a list of employees.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

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[]=[email protected]&emails[]=[email protected]

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

string

enum

Defaults to active

Filter people by status.

Allowed:

page

integer

Defaults to 1

A cursor for pagination across multiple pages of results.

hired_on[gte]

date

Filter people hired on or before this value.

hired_on[lte]

date

Filter people hired on or after this value.

manager_id

integer

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

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/x-www-form-urlencoded

200OK