EndpointsTime Off

List Time Off Requests

Returns the time off requests of the organization — vacations, leaves and permissions — paginated and filterable. Each item includes the request itself, the policy it belongs to and the requesting user (with their position).

Authentication

Api-Keystring

API key of the organization. Always sent together with the Secret-Access header.

Path parameters

organization_slugstringRequired

Headers

Secret-AccessstringRequired

Query parameters

keywordstringOptional

Free-text search across the requests.

statuslist of enumsOptional
Filter by request status. Repeat the parameter to pass several values.
Allowed values:
policy_idslist of stringsOptional
Filter by time off policy id. Repeat the parameter to pass several ids.
policy_type_idslist of stringsOptional
Filter by policy type id. Repeat the parameter to pass several ids.
centralized_user_idslist of stringsOptional

Filter by user id (centralized user id). Repeat the parameter to pass several ids.

date_fromdateOptional

Start of the date range (inclusive). Format: YYYY-MM-DD.

date_todateOptional

End of the date range (inclusive). Format: YYYY-MM-DD.

specific_datedateOptional

Return requests active on this exact date. Format: YYYY-MM-DD.

order_byenumOptional
Sort order for the results.
limitintegerOptional1-50

Results per page (1-50).

offsetintegerOptional>=0

Number of results to skip (zero-based).

Response

Time off requests page
resultslist of objects
totalintegerOptional

Errors

400
Bad Request Error
422
Unprocessable Entity Error