List onboarding employees | Deel

curl -G https://api.letsdeel.com/rest/v2/onboarding/tracker \
     -H "Authorization: Bearer <token>" \
     --data-urlencode "search=John Doe" \
     -d contractOid=OMD123 \
     -d contractOid=67E890 \
     -d hiringTypes=contractor \
     -d progressStatuses=ACTIVE \
     -d countries=USA \
     -d countries=Canada \
     -d teams=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
     -d legalEntities=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
     -d hrisDirectManagers=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
     --data-urlencode fromDate=2024-01-01T00:00:00Z \
     --data-urlencode toDate=2024-12-31T23:59:59Z \
     -d actions=ONBOARD \
     -d actions=COMPLETE \
     -d limit=20 \
     -d sort_by=progressStatusWeight \
     -d sort_order=DESC \
     -d cursor=eyJwYWdlIjoiMTIwIiwiY3JlYXRlZF9hdCI6IjIwMjYtMDItMDIgMDU6MzQ6MjUuNjM1Mjg2In0 \
     -d include_overview=false

{
  "data": [
    {
      "name": "John Doo",
      "contract": {
        "id": "PzpYaren",
        "effective_date": "2021-07-14"
      },
      "progress": {
        "status": "ONBOARDING_OVERDUE",
        "reference_date": "2021-07-14",
        "people_list_status": "onboarding_overdue",
        "subject_to_overdue": true,
        "onboarding_due_date": "2021-07-14T22:00:00+00:00",
        "reference_date_type": "EFFECTIVE_DATE",
        "reference_date_timezone": "Europe/Brussels",
        "is_action_required_from_client": false
      },
      "unique_id": "eyJjb250cmFjdE9pZCI6IlB6cFlhcmVuIiwiaGlyaW5nVHlwZSI6ImNvbnRyYWN0b3IiLCJwcm9maWxlSWQiOjE2NzgyMCwidXNlcklkIjoxNDM3ODl9",
      "hiring_type": "contractor",
      "hris_profile": {
        "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
        "work_email": "2635e57fe2a571c1aadba2a77f178e2b@test.com"
      },
      "app_experience": {
        "is_minimal_requirements": false
      }
    }
  ],
  "page": {
    "cursor": "eyJsaW1pdCI6MiwicGFnaW5hdGlvbiI6eyJwcm9ncmVzc1N0YXR1c1dlaWdodCI6MSwicmVmZXJlbmNlRGF0ZSI6IjIwMjEtMDctMThUMjI6MDA6MDArMDA6MDAiLCJlZmZlY3RpdmVEYXRlIjoiMjAyMS0wNy0xOFQyMjowMDowMCswMDowMCIsImNvbnRyYWN0SWQiOiJONzZsWHdreiJ9LCJzb3J0T3JkZXIiOiJBU0MifQ",
    "total_rows": 86
  }
}

Returns a list of all workers currently going through the onboarding process, including contract details, HRIS profile information, current onboarding status, and onboarding due dates. Use this endpoint to monitor onboarding progress, track pending actions, and ensure deadlines are met. 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

contractOidlist of stringsOptional

Search attribute to filter onboarding list by contract id

hiringTypeslist of enumsOptional

Search attribute to filter onboarding list by hiring type

Allowed values:

progressStatuseslist of enumsOptional

Search attribute to filter onboarding list by progress status

Allowed values:

countrieslist of stringsOptional

Search attribute to filter onboarding list by country

teamslist of stringsOptional

Search attribute to filter onboarding list by team

legalEntitieslist of stringsOptional

Search attribute to filter onboarding list by legal entity

hrisDirectManagerslist of stringsOptional

Search attribute to filter onboarding list by HRIS direct manager

fromDatestringOptionalformat: "date-time"

Start date for filtering contracts

toDatestringOptionalformat: "date-time"

End date for filtering contracts

actionslist of enumsOptional

Onboarding actions

Allowed values:

limitintegerOptional1-200Defaults 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:

cursorstringOptional

Cursor for pagination

include_overviewbooleanOptionalDefaults to false

Include an overview of the contract

Response

A list of onboarding and their details

datalist of objects

pageobject

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'