COconnecteam
Time Off:v1:TimeOffRequests

Get time off requests

Changed on

Retrieve a paginated list of time-off requests whose date range overlaps the requested window, with optional filtering by employees and statuses. Approved requests include duration (the amount deducted from balance, in the policy units of hours or days); it is omitted for other statuses. Defaults to approved status when no status filter is provided.

get/time-off/v1/requests

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/time-off/v1/requests
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: time_off.read

Query parameters

startDatestring required

Start of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Any request overlapping [startDate, endDate] is returned.

endDatestring required

End of the date range, inclusive, in ISO 8601 format (YYYY-MM-DD). Must be on or after startDate. Range may not exceed 365 days.

userIdsinteger[]

Filter by one or more employee IDs. Omit to include all employees.

statusesstring[]

Filter by status. Allowed: approved, pending, denied. Repeat the param for multiple values. Defaults to ['approved'] when omitted.

limitinteger

The maximum number of results to display per page

offsetinteger

The resource offset of the last successfully read resource will be returned as the paging.offset JSON property of a paginated response containing more results

Response

Successful Response

requestIdstring

Changes

  • a01dde7c27fbRevision changes
    • info

      added the optional property /// to the response with the status