List time-off requests for Organization

GET

/time_offs

GET

/rest/time_offs

curl -G https://api.letsdeel.com/rest/time_offs \
     -H "Authorization: Bearer <token>" \
     --data-urlencode approval_end_date=2022-01-01T00:00:00Z \
     --data-urlencode approval_start_date=2022-01-01T00:00:00Z \
     --data-urlencode end_date=2022-01-01T00:00:00Z \
     -d include_deleted_time_offs=false \
     -d next=d290f1ee-6c54-4b01-90e6-d701748f0851 \
     -d page_size=10 \
     -d policy_type_names=Vacation \
     -d policy_types=d290f1ee-6c54-4b01-90e6-d701748f0851 \
     --data-urlencode start_date=2022-01-01T00:00:00Z \
     -d status=REQUESTED \
     -d time_off_ids=d290f1ee-6c54-4b01-90e6-d701748f0851 \
     --data-urlencode updated_end_date=2022-01-01T00:00:00Z \
     --data-urlencode updated_start_date=2022-01-01T00:00:00Z

{
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "amount": 0.5,
      "is_paid": true,
      "end_date": "2022-01-01",
      "created_at": "2022-01-01T00:00:00Z",
      "start_date": "2022-01-01",
      "updated_at": "2022-01-01T00:00:00Z",
      "requested_at": "2022-01-01",
      "half_end_date": true,
      "half_start_date": true,
      "entitlement_unit": "CALENDAR_DAY",
      "time_off_type_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "reason": "Vacation",
      "status": "REQUESTED",
      "deleted_at": "2022-01-01T00:00:00Z",
      "approved_at": "2022-01-01T00:00:00Z",
      "canceled_at": "2022-01-01T00:00:00Z",
      "description": "Vacation",
      "contract_oid": "32fk5ds",
      "time_off_type": {
        "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "name": "Vacation",
        "policy": {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "name": "Standard Vacation Policy",
          "policy_type": {
            "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
            "name": "Vacation"
          }
        }
      },
      "time_off_origin": "PUBLIC_API",
      "deduction_amount": 0.5,
      "time_off_dailies": [
        {
          "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "date": "2022-01-01",
          "type": "WORKING_DAY",
          "amount": 0.5,
          "created_at": "2022-01-01T00:00:00Z",
          "updated_at": "2022-01-01T00:00:00Z",
          "time_off_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
          "description": "Vacation"
        }
      ],
      "recipient_profile": {
        "hris_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "client_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "requester_profile": {
        "hris_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "organization_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
        "client_profile_id": "d290f1ee-6c54-4b01-90e6-d701748f0851"
      },
      "time_off_percentage": 0.5,
      "is_end_date_estimated": true,
      "other_type_description": "Vacation"
    }
  ],
  "page_size": 10,
  "has_next_page": true,
  "next": "string",
  "count": 100
}

Returns time-off requests for the authenticated organization, with optional filtering by status, date ranges, policy types, and specific request IDs. Results are paginated using cursor-based navigation.

Token scopes: time-off:read

Authentication

AuthorizationBearer

Authentication

The Deel API uses bearer tokens to authenticate requests. All API calls must be made over HTTPS — calls over plain HTTP or without authentication will fail.

curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \
  -H 'Authorization: Bearer YOUR-TOKEN-HERE'

Learn more about authentication

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

statuslist of enumsOptional

Time off status

time_off_idslist of stringsOptional

Time off ids

start_datestringOptionalformat: "date-time"

Start date of time off

end_datestringOptionalformat: "date-time"

End date of time off

approval_start_datestringOptionalformat: "date-time"

Approval start date

approval_end_datestringOptionalformat: "date-time"

Approval end date

updated_start_datestringOptionalformat: "date-time"

Updated start date

updated_end_datestringOptionalformat: "date-time"

Updated end date

page_sizeintegerOptional5-200

Page size

policy_typeslist of stringsOptional

Policy types

policy_type_nameslist of enumsOptional

Filter by policy type names. When omitted, Work Location time-offs are excluded by default. Pass policy_type_names=Work+Location to retrieve only Work Location entries.

nextstringOptional

include_deleted_time_offsbooleanOptionalDefaults to false

When true, includes soft-deleted time-off records in the response. Deleted records will have a deleted_at timestamp and status DELETED.

Response

Successful operation time offs returned

datalist of objects

page_sizeinteger5-200

Page size

has_next_pageboolean

Has next page

nextstringOptional

countintegerOptional

Total count of items

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error