V1ListEmployeesRequest

July 10, 2019 ยท View on GitHub

Description

Properties

NameTypeDescriptionNotes
orderStringThe order in which employees are listed in the response, based on their created_at field. Default value: ASC See SortOrder for possible values[optional]
beginUpdatedAtStringIf filtering results by their updated_at field, the beginning of the requested reporting period, in ISO 8601 format[optional]
endUpdatedAtStringIf filtering results by there updated_at field, the end of the requested reporting period, in ISO 8601 format.[optional]
beginCreatedAtStringIf filtering results by their created_at field, the beginning of the requested reporting period, in ISO 8601 format.[optional]
endCreatedAtStringIf filtering results by their created_at field, the end of the requested reporting period, in ISO 8601 format.[optional]
statusStringIf provided, the endpoint returns only employee entities with the specified status (ACTIVE or INACTIVE). See V1ListEmployeesRequestStatus for possible values[optional]
externalIdStringIf provided, the endpoint returns only employee entities with the specified external_id.[optional]
limitIntegerThe maximum integer number of employee entities to return in a single response. Default 100, maximum 200.[optional]
batchTokenStringA pagination cursor to retrieve the next set of results for your original query to the endpoint.[optional]