List onboarding employees

GET

/onboarding/tracker

GET

/rest/onboarding/tracker

$ curl -G https://api.letsdeel.com/rest/onboarding/tracker \
>      -H "Authorization: Bearer <token>" \
>      --data-urlencode "search=John Doe" \
>      -d contractOid=OMD123 \
>      -d contractOid=67E890 \
>      -d hiringTypes=contractor \
>      -d hiringTypes=eor \
>      -d progressStatuses=ACTIVE \
>      -d countries=US \
>      -d countries=CA \
>      -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=CLIENT_ACTION_REQUIRED \
>      -d limit=20 \
>      -d sort_by=progressStatusWeight \
>      -d sort_order=DESC \
>      -d cursor=eyJwYWdlIjoiMTIwIiwiY3JlYXRlZF9hdCI6IjIwMjYtMDItMDIgMDU6MzQ6MjUuNjM1Mjg2In0 \
>      -d include_overview=false

1 {
2   "data": [
3     {
4       "name": "John Doo",
5       "contract": {
6         "id": "PzpYaren",
7         "effective_date": "2021-07-14"
8       },
9       "progress": {
10         "status": "ONBOARDING_OVERDUE",
11         "reference_date": "2021-07-14",
12         "people_list_status": "onboarding_overdue",
13         "subject_to_overdue": true,
14         "onboarding_due_date": "2021-07-14T22:00:00+00:00",
15         "reference_date_type": "EFFECTIVE_DATE",
16         "reference_date_timezone": "Europe/Brussels",
17         "is_action_required_from_client": false
18       },
19       "unique_id": "eyJjb250cmFjdE9pZCI6IlB6cFlhcmVuIiwiaGlyaW5nVHlwZSI6ImNvbnRyYWN0b3IiLCJwcm9maWxlSWQiOjE2NzgyMCwidXNlcklkIjoxNDM3ODl9",
20       "hiring_type": "contractor",
21       "hris_profile": {
22         "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
23         "work_email": "2635e57fe2a571c1aadba2a77f178e2b@test.com"
24       },
25       "app_experience": {
26         "is_minimal_requirements": false
27       }
28     }
29   ],
30   "page": {
31     "cursor": "eyJsaW1pdCI6MiwicGFnaW5hdGlvbiI6eyJwcm9ncmVzc1N0YXR1c1dlaWdodCI6MSwicmVmZXJlbmNlRGF0ZSI6IjIwMjEtMDctMThUMjI6MDA6MDArMDA6MDAiLCJlZmZlY3RpdmVEYXRlIjoiMjAyMS0wNy0xOFQyMjowMDowMCswMDowMCIsImNvbnRyYWN0SWQiOiJONzZsWHdreiJ9LCJzb3J0T3JkZXIiOiJBU0MifQ",
32     "total_rows": 86
33   }
34 }

Returns a list of workers currently going through onboarding, including contract details, HRIS profile information, current onboarding status, and onboarding due dates. Supports cursor-based pagination.

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.deel.training/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.deel.training/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

progressStatuseslist of enumsOptional

Search attribute to filter onboarding list by progress status

countrieslist of stringsOptional

Filter by contract country. Uses ISO 3166-1 alpha-2 codes.

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. Expects the manager’s HRIS profile ID, as returned by GET /people in employments[].team.direct_manager_id — not a worker or contract ID.

fromDatestringOptionalformat: "date-time"

Start date for filtering contracts

toDatestringOptionalformat: "date-time"

End date for filtering contracts

actionslist of enumsOptional

Filter by whether the onboarding is waiting on an action from the client

Allowed values:

limitintegerOptional1-200Defaults to 20

Number of results to return per page. Ignored when cursor is supplied — a cursor already carries the page size and filters of the request that produced it.

sort_byenumOptionalDefaults to progressStatusWeight

Field to sort by

Allowed values:

sort_orderenumOptionalDefaults to ASC

Sorting order

Allowed values:

cursorstringOptional

Cursor for pagination, taken from page.cursor of the previous response. It replaces the other query parameters, which are carried over from the request that produced it.

include_overviewbooleanOptionalDefaults to false

Include an overview of the contract

Response

A list of onboarding and their details

datalist of objectsOptional

pageobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error

$	curl -X GET 'https://api.deel.training/rest/v2/contracts' \
>	-H 'Authorization: Bearer YOUR-TOKEN-HERE'