List Time Off Types

Lists the company's active time off types — PTO options, vacation, sick leave, and other time off categories — along with the company's default hours-per-day schedule. Pass mode=request to filter to only types the authenticated employee has permission to request. Time off type names are company-configured labels; common terms like "PTO" may not appear verbatim and may be expressed as "Vacation" or another company-specific name. The returned list is also permission-filtered: an admin caller may see types (e.g., "Sick") that a non-admin caller does not, so the set available for a given user depends on the caller's role. If a user's term does not exactly match a returned type name, present the available types as options rather than choosing one heuristically.

OAuth Scopes: time_off

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Set to request to limit the results to time off types the authenticated employee can request.

Allowed:
Headers
string
enum

This endpoint can produce either JSON or XML.

Allowed:
Responses

401

Unauthorized. Invalid API credentials.

Language
Credentials
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json