Retrieve offboarding list | Deel

import requests
url = "https://api.letsdeel.com/rest/v2/offboarding/tracker"
querystring = {"search":"John Doe","hiring_types":"[\"contractor\"]","progress_statuses":"[\"ACTIVE\"]","limit":"50","sort_by":"progressStatusWeight","sort_order":"DESC","include_overview":"false","ignore_date_range":"false"}
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers, params=querystring)
print(response.json())

{
  "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": "eyJjb250cmFjdE9pZCI6Im03eWc2enAiLCJoaXJpbmdUeXBlIjoiY29udHJhY3RvciIsImhyaXNQcm9maWxlT2lkIjoiYjU1MGI3ZTUtZDZlMS00NjEzLTkzYmEtYTdlZTVmNzU4ODdjIn0",
      "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
  }
}

Retrieve offboarding list 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.

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/

Query parameters

searchstringOptional

Search term to filter contracts by name or other attributes

hiring_typeslist of enumsOptional

Allowed values:

progress_statuseslist of enumsOptional

Allowed values:

limitintegerOptional>=1Defaults to 20

Number of results to return per page

sort_byenumOptionalDefaults to progressStatusWeight

Field to sort by

Allowed values:

sort_orderenumOptionalDefaults to ASC

Sorting order

Allowed values:

paginationobjectOptional

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 objects or null

A list of offboarding items.

pageobject or null

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

Authentication

Authentication

Query parameters

Response

Errors

Authentication