List onboarding employees

GET

/onboarding/tracker

GET

/rest/onboarding/tracker

curl -G https://api.letsdeel.com/rest/onboarding/tracker \
     -H "Authorization: Bearer <token>" \
     -d actions=CLIENT_ACTION_REQUIRED \
     -d card=WITH_DEEL_FOR_REVIEW \
     -d contractOid=OMD123 \
     -d contractOid=67E890 \
     -d countries=US \
     -d countries=CA \
     -d cursor=eyJwYWdlIjoiMTIwIiwiY3JlYXRlZF9hdCI6IjIwMjYtMDItMDIgMDU6MzQ6MjUuNjM1Mjg2In0 \
     --data-urlencode fromDate=2024-01-01T00:00:00Z \
     -d hiringTypes=contractor \
     -d hiringTypes=eor \
     -d hrisDirectManagers=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
     -d include_overview=false \
     -d legalEntities=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
     -d lifecycleStatuses=ONBOARDING \
     -d limit=20 \
     -d progressStatuses=ACTIVE \
     --data-urlencode "search=John Doe" \
     -d sort_by=progressStatusWeight \
     -d sort_order=DESC \
     -d teams=c64c6715-e0ca-4ff0-aa53-d4c0db499360 \
     --data-urlencode toDate=2024-12-31T23:59:59Z \
     -d waitingOnParties=WORKER \
     -d weekFromDate=2026-09-21 \
     -d weekToDate=2026-09-27

{
  "data": [
    {
      "name": "John Doo",
      "worker": {
        "id": "150f635e-fae1-4b9d-9f86-768bbbac3698",
        "name": "John Doo",
        "job_title": "Software Engineer",
        "avatar_url": "https://example.com/avatar.png",
        "is_entity_contractor": false,
        "is_contractor_of_record": false
      },
      "country": {
        "code": "BR",
        "name": "Brazil"
      },
      "profile": {
        "pic_url": "https://example.com/avatar.png"
      },
      "contract": {
        "id": "PzpYaren",
        "eor": {
          "is_unassigned_candidate": false,
          "has_additional_active_eor_contracts": false
        },
        "is_pwac": false,
        "effective_date": "2021-07-14",
        "global_payroll": {
          "has_direct_employee_app": true
        },
        "offer_letter_id": "150f635e-fae1-4b9d-9f86-768bbbac3698"
      },
      "overview": {
        "banner": {
          "key": "ONBOARDING_OVERDUE",
          "action": "CANCEL_CONTRACT",
          "severity": "ERROR"
        },
        "actions": [
          {
            "data": {},
            "type": "SEND_REMINDER",
            "available": true,
            "last_execution_at": "2026-09-20T10:00:00.000Z"
          }
        ],
        "profile": {
          "id": 12345,
          "name": "John Doo",
          "email": "test@email.com",
          "country": "CA",
          "pic_url": "https://example.com/avatar.png",
          "last_login": "2021-07-14T22:00:00+00:00",
          "paid_invoices": [
            {
              "id": 12345,
              "status": "paid"
            }
          ],
          "previously_onboarded": true
        },
        "stepper": [
          {
            "data": {
              "total": 8,
              "emails": [
                {
                  "meta": {
                    "type": "CONTRACTOR_INVITE_SIGN_UP",
                    "email": "test@email.com",
                    "sent_at": "2021-07-14T22:00:00+00:00"
                  }
                }
              ],
              "completed": 3,
              "remaining": 5,
              "next_reminder_date": "2021-07-14T22:00:00+00:00",
              "onboarding_due_date": "2026-10-01T00:00:00.000Z"
            },
            "type": "REMINDER_SENT",
            "completed_at": "2021-07-14T22:00:00+00:00"
          }
        ],
        "summary": [
          {
            "data": {
              "country": "CA",
              "timezone": "Europe/Brussels",
              "has_withdraw_methods": true
            },
            "name": "Contract start date",
            "type": "START_DATE",
            "value": "2021-07-14T22:00:00+00:00"
          }
        ],
        "contract": {
          "id": "PzpYaren",
          "oid": "PzpYaren",
          "name": "Contract Name",
          "status": "in_progress",
          "is_pwac": false,
          "created_at": "2021-07-14T22:00:00+00:00",
          "first_sign": "client",
          "completion_date": "2021-07-14T22:00:00+00:00",
          "client_signed_at": "2021-07-14T22:00:00+00:00",
          "employee_agreement": {
            "phase": "countersigned",
            "status": "AwaitingEmployeeSignature",
            "version_hash": "cdf4f572eb13a5eaf46d"
          },
          "first_early_invoice": {
            "id": "9r259RyjAnP7GeMpQnjAT",
            "amount": "100.00",
            "status": "PENDING",
            "paid_at": "2026-03-01T00:00:00+00:00",
            "currency": "EUR",
            "due_date": "2026-04-01T00:00:00.000Z",
            "description": "EOR funding statement for February, 2026"
          },
          "contractor_signed_at": "2021-07-14T22:00:00+00:00",
          "invited_contractor_email": "test@email.com"
        },
        "progress": {
          "status": "ACTIVE",
          "sub_status": "PENDING_INVITE",
          "reference_date": "2021-07-14T22:00:00+00:00",
          "subject_to_overdue": true,
          "reference_date_timezone": "Europe/Brussels",
          "is_action_required_from_client": true
        },
        "checklist": {
          "steps": [
            {
              "data": {},
              "type": "sign_up_to_deel",
              "group": "OUTSTANDING",
              "label": "Create contractor account",
              "state": "IN_REVIEW",
              "status": "done",
              "ordinal": 3,
              "category": "Identity & personal data",
              "due_date": "2021-07-14T22:00:00+00:00",
              "description": "Upload your ID document",
              "display_key": "PERSONAL_DETAILS",
              "category_key": "IDENTITY_PERSONAL_DATA",
              "completed_at": "2021-07-14T22:00:00+00:00",
              "reject_reason": "<p>Please submit the correct document for Form 145</p>"
            }
          ],
          "summary": {
            "total": 8,
            "completed": 3,
            "outstanding": 5
          }
        },
        "contracts": [
          {
            "entity": {
              "id": "150f635e-fae1-4b9d-9f86-768bbbac3698",
              "name": "Acme Inc."
            },
            "status": "ONBOARDING",
            "is_main": true,
            "is_pwac": false,
            "job_title": "Software Engineer",
            "is_current": true,
            "start_date": "2021-07-14",
            "tracker_id": "eyJjb250cmFjdE9pZCI6IlB6cFlhcmVuIiwiaGlyaW5nVHlwZSI6ImNvbnRyYWN0b3IifQ",
            "worker_type": "contractor",
            "contract_oid": "PzpYaren",
            "lifecycle_status": "ONBOARDING",
            "is_attention_needed": false
          }
        ],
        "hiring_type": "contractor",
        "hris_profile": {
          "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
          "name": "John Doo",
          "email": "test@email.com",
          "work_email": "test@email.com",
          "invitations": [
            {
              "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
              "status": "SCHEDULED",
              "send_at": "2026-09-20T10:00:00.000Z",
              "timezone": "Europe/Brussels"
            }
          ],
          "direct_manager": {
            "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
            "name": "Jane Doe",
            "pic_url": "https://example.com/avatar.png",
            "job_title": "Engineering Manager",
            "work_email": "manager@email.com"
          }
        },
        "app_experience": {
          "experience_type": "LIGHTWEIGHT",
          "is_minimal_requirements": false
        }
      },
      "progress": {
        "steps": {
          "total": 8,
          "overdue": 1,
          "completed": 3,
          "in_review": 0,
          "in_progress": 1,
          "not_started": 3
        },
        "status": "ONBOARDING_OVERDUE",
        "sub_status": "PENDING_INVITE",
        "waiting_on": "WORKER",
        "reference_date": "2021-07-14",
        "lifecycle_status": "ONBOARDING",
        "people_list_status": "onboarding_overdue",
        "subject_to_overdue": true,
        "onboarding_due_date": "2021-07-14",
        "reference_date_type": "EFFECTIVE_DATE",
        "reference_date_timezone": "Europe/Brussels",
        "is_action_required_from_client": false
      },
      "contracts": [
        {
          "entity": {
            "id": "150f635e-fae1-4b9d-9f86-768bbbac3698",
            "name": "Acme Inc."
          },
          "status": "ONBOARDING",
          "is_main": true,
          "is_pwac": false,
          "job_title": "Software Engineer",
          "start_date": "2021-07-14",
          "tracker_id": "eyJjb250cmFjdE9pZCI6IlB6cFlhcmVuIiwiaGlyaW5nVHlwZSI6ImNvbnRyYWN0b3IifQ",
          "worker_type": "contractor",
          "contract_oid": "PzpYaren",
          "lifecycle_status": "ONBOARDING",
          "is_attention_needed": false
        }
      ],
      "unique_id": "eyJjb250cmFjdE9pZCI6IlB6cFlhcmVuIiwiaGlyaW5nVHlwZSI6ImNvbnRyYWN0b3IiLCJwcm9maWxlSWQiOjE2NzgyMCwidXNlcklkIjoxNDM3ODl9",
      "start_date": "2021-07-14",
      "hiring_type": "contractor",
      "hris_profile": {
        "oid": "150f635e-fae1-4b9d-9f86-768bbbac3698",
        "work_email": "2635e57fe2a571c1aadba2a77f178e2b@test.com"
      },
      "pending_steps": "Sign the contract, Upload documents",
      "app_experience": {
        "experience_type": "LIGHTWEIGHT",
        "is_minimal_requirements": false
      },
      "invitation_sent": false,
      "can_send_invitation": true
    }
  ],
  "page": {
    "cursor": "eyJsaW1pdCI6MiwicGFnaW5hdGlvbiI6eyJwcm9ncmVzc1N0YXR1c1dlaWdodCI6MSwicmVmZXJlbmNlRGF0ZSI6IjIwMjEtMDctMThUMjI6MDA6MDArMDA6MDAiLCJlZmZlY3RpdmVEYXRlIjoiMjAyMS0wNy0xOFQyMjowMDowMCswMDowMCIsImNvbnRyYWN0SWQiOiJONzZsWHdreiJ9LCJzb3J0T3JkZXIiOiJBU0MifQ",
    "total_rows": 86
  }
}

Use this endpoint to monitor workers as they progress through onboarding and identify onboarding records that require follow-up.

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

AuthorizationBearer

Standard OAuth2 security scheme based on https://swagger.io/docs/specification/authentication/

Query parameters

searchstringOptional<=255 characters

Search term to filter contracts by name or other attributes

contractOidlist of stringsOptionalDefaults to []

Search attribute to filter onboarding list by contract id

hiringTypeslist of enumsOptionalDefaults to []

Search attribute to filter onboarding list by hiring type

progressStatuseslist of enumsOptionalDefaults to []

Search attribute to filter onboarding list by progress status

countrieslist of stringsOptionalDefaults to []

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

teamslist of stringsOptionalDefaults to []

Search attribute to filter onboarding list by team

legalEntitieslist of stringsOptionalDefaults to []

Search attribute to filter onboarding list by legal entity

hrisDirectManagerslist of stringsOptionalDefaults to []

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 enumsOptionalDefaults to []

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

Allowed values:

lifecycleStatuseslist of enumsOptionalDefaults to []

Filter by lifecycle status, the same value each item returns in progress.lifecycle_status

waitingOnPartieslist of enumsOptionalDefaults to []

Filter by the party the onboarding is waiting on, the same value each item returns in progress.waiting_on

Allowed values:

cardenumOptional

Narrow the list to the workers one filter card counts. STARTING_THIS_WEEK also needs weekFromDate and weekToDate.

Allowed values:

weekFromDatestringOptionalformat: "date"

First day of the week the STARTING_THIS_WEEK card counts, in the caller’s timezone

weekToDatestringOptionalformat: "date"

Last day of the week the STARTING_THIS_WEEK card counts, in the caller’s timezone. On or after weekFromDate

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