Square.Connect.Model.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]
Limitint?The 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]

[Back to Model list] [Back to API list] [Back to README]