v1

latestOpenAPI 3.0.0Apache 2.02026-07-143281,4552.1 MB
Employees

ListEmployees

get/v2/employees

Query parameters

location_idstring
status'ACTIVE' | 'INACTIVE'

The status of the Employee being retrieved.

DEPRECATED at version 2020-08-26. Replaced by TeamMemberStatus.

Specifies the EmployeeStatus to filter the employee by.

limitinteger

The number of employees to be returned on each page.

cursorstring

The token required to retrieve the specified page of results.

Response

Success

cursorstring

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