Retrieve Employee Time Off Data for Offboarding | Deel

curl -G https://api.letsdeel.com/rest/v2/eor/contracts/5B74FnLM/offboarding/time-offs \
     -H "Authorization: Bearer <token>" \
     -d end_date=2025-10-20

{
  "data": {
    "contract_id": "r78nrqi",
    "entitlements": [
      {
        "id": "aa3b5309-7f99-4417-b082-17aff902ddb5",
        "used": 13,
        "requests": 1,
        "created_at": "2025-09-11T00:00:00.000Z",
        "updated_at": "2025-09-11T00:00:00.000Z",
        "tracking_period": "2025-03-14",
        "entitlement_unit": "CALENDAR_DAY",
        "tracking_period_end_date": "2026-03-13"
      }
    ],
    "tracking_type": "ON_PLATFORM",
    "policy_settings": {
      "entitlement_unit": "CALENDAR_DAY",
      "is_accrued_days_available": true,
      "is_estimated_payout_available": true
    },
    "upcoming_time_offs": [
      {
        "id": "aa3b5309-7f99-4417-b082-17aff902ddb5",
        "amount": 13,
        "status": "APPROVED",
        "end_date": "2025-12-28T00:00:00Z",
        "created_at": "2025-09-11T00:00:00.000Z",
        "start_date": "2025-12-08T00:00:00Z",
        "updated_at": "2025-09-11T00:00:00.000Z",
        "approved_at": "2025-08-13T00:00:00.000Z",
        "requested_at": "2025-08-13T00:00:00.000Z"
      }
    ],
    "has_external_integration": true,
    "remaining_balance": 36.49
  }
}

This endpoint provides detailed time off information for an employee, including accrued, used, and scheduled days across all tracking periods. It also includes policy details, tracking configurations, and additional metadata to support the offboarding request process. The data is used to display comprehensive time off information on the offboarding request page. Token scopes: contracts: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.

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

Learn more about authentication

## 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 curl -X GET 'https://api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` [Learn more about authentication](/api/authentication)

AuthorizationBearer

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

Path parameters

contract_idstringRequired

The unique identifier of the employee contract.

Query parameters

end_datestringOptionalformat: "date"

Desired end date for offboarding

Response

Successfully retrieved used time off information

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

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