Sign in

v1

latestOpenAPI 3.1.02026-07-26294215839.4 KB
Time Off
Public API

List Time Off Requests

Returns time off requests within the specified date range. Both start and end query parameters are required (YYYY-MM-DD). The search is inclusive: requests whose date range overlaps the query window are returned. Results can be filtered by status, employee, time off type, or limited to requests the caller can approve.

OAuth Scopes: time_off

get/api/v1/time_off/requests

Query parameters

idstring

A particular request ID to limit the response to.

action'view' | 'approve' | 'myRequests'

Limit to requests the caller can view, requests they can approve, or only their own requests via myRequests. Defaults to view.

employeeIdstring

A particular internal employee ID to limit the response to.

startstring date required

The left boundary of the search window, in YYYY-MM-DD format. Returns any request whose end date falls on or after this date — i.e., requests that are still active at the start of your window. To find all requests overlapping a date range, pass your range start here. Note: this parameter filters on each request's end date, not its start date.

endstring date required

The right boundary of the search window, in YYYY-MM-DD format. Returns any request whose start date falls on or before this date — i.e., requests that have begun by the end of your window. To find all requests overlapping a date range, pass your range end here. Note: this parameter filters on each request's start date, not its end date.

typestring

A comma-separated list of time off type IDs to filter by. If omitted, requests of all types are included.

statusstring

A comma-separated list of request status values to filter by. Accepted values are approved, denied, superceded, requested, and canceled. If omitted, requests of all statuses are included.

excludeNotestring

When set to any truthy value, omits the notes object from each request in the response.

Headers

AcceptHeaderParameter'application/xml' | 'application/json'

This endpoint can produce either JSON or XML.

Response

A list of time off requests matching the specified filters.

idstring

The time off request ID.

employeeIdstring

The internal employee ID.

namestring

The employee's full name.

startstring date

The start date of the request in YYYY-MM-DD format.

endstring date

The end date of the request in YYYY-MM-DD format.

createdstring date

The date the request was created in YYYY-MM-DD format (company timezone).

datesobject

A map of dates (YYYY-MM-DD) to daily amounts.

Example response

[
  {
    "id": "1348",
    "employeeId": "5"
  }
]