BAbamboohr
Time Off
Public API

List Time Off Requests

Changed on

Lists time off requests, with support for filtering, sorting, and pagination.

OAuth Scopes: time_off:requests

get/api/v1/time-off/requests

Request

Query parameters

filterstring

OData filter expression applied to time off requests. Supported operators: eq (equals, use eq null to match NULL), ne (not equals, use ne null to match NOT NULL), lt (less than), le (less than or equal), gt (greater than), ge (greater than or equal), in (value in list), and (combine clauses). Not supported: or, not, parenthesized grouping. Filterable fields: id, employeeId, categoryId, startDate, endDate, amount, unit, status, requestedAt. status accepts the four values of the response enum. A request that a later edit replaced is never returned by this endpoint, so no filter can select one. Examples: status eq 'approved', employeeId in (614, 615, 616), status eq 'approved' and startDate ge '2026-04-01' and endDate le '2026-05-01'.

orderBystring

Sort the results by a property and direction, e.g. requestedAt desc. Defaults to requestedAt desc.

pageinteger

The page number to retrieve.

pageSizeinteger

The number of items to return per page.

returnActionsboolean

Set to true to include the _links block naming the state transitions available to the caller for this time off request. Also accepts 1, yes and on. Omitted from the response by default.

Response

A paginated list of time off requests.

Example response

{
  "data": [
    {
      "id": 1,
      "employeeId": 43046,
      "categoryId": 22,
      "startDate": "2026-01-01",
      "endDate": "2026-01-01",
      "amount": 3.5,
      "unit": "HOURS",
      "status": "APPROVED",
      "requestedAt": "2026-01-01T06:00:00Z",
      "dailyAmounts": [
        {
          "date": "2026-01-01",
          "amount": 8
        }
      ],
      "employeeNote": "Family trip.",
      "managerNote": "Approved. Enjoy your time off!",
      "statusUpdatedAt": "2026-01-02T17:00:00Z",
      "statusUpdatedBy": 2274,
      "_links": {
        "self": {
          "href": "/api/v1/time-off/requests/{id}"
        },
        "edit": {
          "href": "/api/v1/time-off/requests/{id}",
          "method": "PATCH"
        },
        "cancel": {
          "href": "/api/v1/time-off/requests/{id}/cancellations",
          "method": "POST"
        }
      }
    }
  ]
}

Changes