List Time Off Policies
Returns the time off policies configured by the organization — vacations, leaves and permissions — paginated and filterable. Each item describes how the policy behaves: its category, whether it is paid or unlimited, the unit it is measured in and whether requests need approval. It does not include requests nor employee data.
Authentication
Api-Keystring
API key of the organization. Always sent together with the Secret-Access header.
Path parameters
organization_slug
Headers
Secret-Access
Query parameters
policy_id
Filter by policy id. Returns only that policy.
search
Free-text search across the policy names.
name
Filter by exact policy name.
policy_type_ids
Filter by policy category id. Repeat the parameter to pass several ids.
is_paid
Filter by whether the absence is paid.
order_by
Sort order for the results.
Allowed values:
limit
Results per page (1-50).
offset
Number of results to skip (zero-based).
Response
Time off policies page
results
Current page of policies.
total
Total number of matching policies.
Errors
400
Bad Request Error
403
Forbidden Error
422
Unprocessable Entity Error