Retrieve offboarding list

GET

/offboarding/tracker

GET

/rest/offboarding/tracker

curl -G https://api.letsdeel.com/rest/offboarding/tracker \
     -H "Authorization: Bearer <token>" \
     --data-urlencode "search=John Doe" \
     -d hiring_types=eor \
     -d progress_statuses=IN_REVIEW \
     -d limit=50 \
     -d sort_by=progressStatusWeight \
     -d sort_order=DESC \
     -d "pagination[contractId]=contract12345" \
     --data-urlencode "pagination[effectiveDate]=2024-01-01T00:00:00Z" \
     --data-urlencode "pagination[referenceDate]=2024-01-01T00:00:00Z" \
     -d "pagination[progressStatusWeight]=1" \
     -d cursor=eyJsaW1pdCI6MjAsInBhZ2luYXRpb24iOnsuLi59fQ \
     -d include_overview=false \
     -d ignore_date_range=false

{
  "data": [
    {
      "name": "John Doo",
      "contract": {
        "id": "m7yg6zp"
      },
      "progress": {
        "status": "OFFBOARDING_IN_PROGRESS",
        "reference_date": "2021-07-14T22:00:00+00:00",
        "reference_date_type": "2021-07-14T22:00:00+00:00",
        "reference_date_timezone": "Europe/Belgrade"
      },
      "unique_id": "eyJjb250cmFjdE9pZCI6Im03eWc2enAiLCJoaXJpbmdUeXBlIjoiZW9yIn0",
      "hiring_type": "contractor",
      "hris_profile": {
        "oid": "b550b7e5-d6e1-4613-93ba-a7ee5f75887c"
      },
      "app_experience": {
        "is_minimal_requirements": true
      },
      "termination_id": "b550b7e5-d6e1-4613-93ba-a7ee5f75887c",
      "offboarding_type": "ENDING_CONTRACT"
    }
  ],
  "page": {
    "cursor": "eyJsaW1pdCI6MiwicGFnaW5hdGlvbiI6eyJwcm9ncmVzc1N0YXR1c1dlaWdodCI6MSwicmVmZXJlbmNlRGF0ZSI6IjIwMjEtMDctMThUMjI6MDA6MDArMDA6MDAiLCJlZmZlY3RpdmVEYXRlIjoiMjAyMS0wNy0xOFQyMjowMDowMCswMDowMCIsImNvbnRyYWN0SWQiOiJONzZsWHdreiJ9LCJzb3J0T3JkZXIiOiJBU0MifQ",
    "total_rows": 86
  }
}

Returns a list of contracts currently in the offboarding process. By default, results are scoped to a 45-day date range; set ignore_date_range to true to retrieve all terminations regardless of date.

Token scopes: contracts:read, people: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

## 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/

Query parameters

searchstringOptional

Search term to filter contracts by name or other attributes

hiring_typeslist of enumsOptional

Filter by hiring type.

progress_statuseslist of enumsOptional

Filter by offboarding progress status.

limitintegerOptional1-100Defaults to 20

Number of results to return per page (maximum 100; values above this are silently clamped to 100)

sort_byenumOptionalDefaults to progressStatusWeight

Field to sort by

Allowed values:

sort_orderenumOptionalDefaults to ASC

Sorting order

Allowed values:

paginationobjectOptionalDeprecated

Deprecated. Use cursor instead.

cursorstringOptional<=2048 characters

Opaque pagination cursor from the previous response’s page.cursor. Pass it back verbatim to fetch the next page; omit it for the first page.

include_overviewbooleanOptionalDefaults to false

Include an overview of the contract

ignore_date_rangebooleanOptionalDefaults to false

Ignore the default 45-day date range and retrieve all terminations

Response

Successfully retrieved list of offboarding

datalist of objectsOptional

A list of offboarding items.

pageobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error