<- Employees API

Employees API

List employees

DEPRECATED

 /v2/employees

Permissions:EMPLOYEES_READ

Deprecation date

2020-08-26

Retirement date

2021-08-26

Replaced by

SearchTeamMembers

Migration guide
Link to section

Query parameters

Example code

Link to section

location_id

string

Link to section

status

string

Specifies the EmployeeStatus to filter the employee by.

Link to section

limit

integer(32-bit)

The number of employees to be returned on each page.

Link to section

cursor

string

The token required to retrieve the specified page of results.

Link to section

Response fields

Link to section

employees

Link to section

cursor

string

The token to be used to retrieve the next page of results.

Link to section

errors

Any errors that occurred during the request.