List onboarding employees | Deel

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

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/

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

pageobject or null

1	curl -G https://api.letsdeel.com/rest/v2/onboarding/tracker \
2	-H "Authorization: Bearer <token>" \
3	--data-urlencode "search=John Doe" \
4	-d contractOid=OMD123 \
5	-d contractOid=67E890 \
6	-d hiringTypes=contractor \
7	-d progressStatuses=ACTIVE \
8	-d countries=USA \
9	-d countries=Canada \
10	-d teams=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
11	-d legalEntities=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
12	-d hrisDirectManagers=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
13	--data-urlencode fromDate=2024-01-01T00:00:00Z \
14	--data-urlencode toDate=2024-12-31T23:59:59Z \
15	-d actions=ONBOARD \
16	-d actions=COMPLETE \
17	-d limit=20 \
18	-d sort_by=progressStatusWeight \
19	-d sort_order=DESC \
20	-d cursor=eyJwYWdlIjoiMTIwIiwiY3JlYXRlZF9hdCI6IjIwMjYtMDItMDIgMDU6MzQ6MjUuNjM1Mjg2In0 \
21	-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	}

Authentication

Authentication

Query parameters

Response

Errors

Authentication