v1
latestOpenAPI 3.1.02026-07-242735131.1 MBList Time Off Types
Lists all time off types that can be used for the timeoff_type parameter.
Backward compatibility: Calling this endpoint without the type query parameter returns the same response as before (time off types for full-time employments). Existing integrations do not need to change.
Optionally, pass type=contractor to get time off types for contractor employments, or type=full_time for full-time employments (same as omitting the parameter).
Scopes
| Category | Read only Scope | Write only Scope (read access implicit) |
|---|---|---|
| Manage timeoffs (time_and_attendance) | View timeoffs (timeoff:read) | Manage timeoffs (timeoff:write) |
Query parameters
Optional query parameter for the List Time Off Types endpoint.
- contractor — time off types for contractor employments (e.g. includes time_off).
- full_time — time off types for full-time employments (e.g. includes paid_time_off). When omitted, the response is unchanged from previous API versions (full-time types).
Optional. Employment type to list time off types for: contractor or full_time. Omit for backward-compatible behavior (full-time types).
Headers
Requires a Company-scoped access token obtained through the Authorization Code flow or the Refresh Token flow.
The refresh token needs to have been obtained through the Authorization Code flow.
Response
Success
Example response
{
"data": {
"timeoff_types": [
{
"description": "Sick leave",
"name": "sick_leave"
},
{
"description": "Yearly paid vacation days granted to employees.",
"name": "paid_time_off"
}
]
}
}