Retrieve Offboarding Request | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/eor/contracts/1pj00yy/offboarding"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.json())

{
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "end_date": "2025-01-31T00:00:00.000Z",
    "documents": {
      "supporting": [
        {
          "id": "cmddlk1ghehm54l18gejg198r",
          "name": "Supporting Documentation",
          "type": "pdf",
          "created_at": "2025-07-21T21:07:27.713Z",
          "updated_at": "2025-07-21T21:07:27.713Z",
          "is_additional_supporting_document": false
        }
      ],
      "offboarding": [
        {
          "files": [
            {
              "id": "cmdeh9wzgvihue4r54n2y51p4",
              "name": "Employee Sign Off Documents",
              "type": "pdf",
              "created_at": "2025-07-22T11:55:23.068Z",
              "updated_at": "2025-07-22T11:55:23.068Z"
            }
          ],
          "status": "AWAITING_REVIEW",
          "reviewer_type": "EMPLOYEE",
          "is_employee_notification_required": true,
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2025-07-22T11:55:23.068Z",
          "updated_at": "2025-07-22T11:55:23.068Z",
          "reviewed_at": "2025-07-22T12:30:00.000Z",
          "reviewed_by": "John Doe",
          "reviewer_feedback": "Document needs clarification on section 3",
          "notification_instructions": "<p>Please review and provide feedback on the attached documents.</p>"
        }
      ]
    },
    "created_at": "2025-01-31T00:00:00.000Z",
    "updated_at": "2025-01-31T00:00:00.000Z",
    "contract_id": "5B74FnLM",
    "is_sensitive": false,
    "request_data": {
      "reason": "PERFORMANCE",
      "end_date": "2025-01-31T00:00:00.000Z",
      "reason_detail": "Employee is moving to another country",
      "used_time_off": {
        "time_offs": [
          {
            "unit": "BUSINESS_DAY",
            "policy_type": "Vacation",
            "tracking_periods": [
              {
                "used": 0,
                "end_date": "2025-02-28T00:00:00.000Z",
                "start_date": "2024-03-01T00:00:00.000Z"
              },
              {
                "used": 0,
                "end_date": "2024-02-29T00:00:00.000Z",
                "start_date": "2023-03-01T00:00:00.000Z"
              },
              {
                "used": 0,
                "end_date": "2023-02-28T00:00:00.000Z",
                "start_date": "2022-03-01T00:00:00.000Z"
              }
            ],
            "scheduled_until_end_date": 0
          }
        ],
        "is_deel_pto_confirmed": true,
        "additional_details": null
      },
      "desired_end_date": "2025-01-31",
      "eligible_for_rehire": "DONT_KNOW",
      "eligible_for_rehire_reason": "Employee is not eligible for rehire due to performance issues"
    },
    "desired_end_date": "2025-01-31T00:00:00.000Z"
  }
}

Retrieve the offboarding request associated with a specific EOR contract (contract_id). Use it to review termination details, document review status, offboarding request data, and notifications required for the employee. Token scopes: contracts:read, worker: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.

Response

Successful retrieval of the offboarding request.

dataobject

Authentication

Authentication

Path parameters

Response

Errors

Authentication