Retrieve Employee Time Off Data for Offboarding | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/eor/contracts/5B74FnLM/offboarding/time-offs"
querystring = {"end_date":"2025-10-20"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "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

Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE'

## Authentication Deel API uses API tokens to authenticate requests. A bearer token is required to authenticate all API requests. All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail. ``` curl -X GET 'api.letsdeel.com/rest/v2/contracts' \ -H 'Authorization: Bearer YOUR-TOKEN-HERE' ``` ### Generating Access Tokens 1. Navigate to **Apps & Perks > Developer Center**. 2. Click on the “Generate New Token” button. 3. In the popup, click “Generate Token” button to generate a new token. Your newly generated token is visible on the screen. 4. Make sure to copy and save your token once is generated. You won't be able to see it again!

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

Authentication

Authentication

Path parameters

Query parameters

Response

Errors

Authentication