Get onboarding details by employee HRIS profile ID

GET

/onboarding/tracker/hris_profile/:hris_profile_id

GET

/rest/onboarding/tracker/hris_profile/:hris_profile_id

curl https://api.letsdeel.com/rest/onboarding/tracker/hris_profile/150f635e-fae1-4b9d-9f86-768bbbac3698 \
     -H "Authorization: Bearer <token>"

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

Use this endpoint to see where one worker is in onboarding and what is needed next, when you hold their HRIS profile ID, for example from GET /people or hris_profile.oid on the onboarding tracker list. It covers the worker’s main contract and lists their other contracts.

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/

Path parameters

hris_profile_idstringRequired

The unique identifier of the employee HRIS profile.

Response

Onboarding overview

dataobjectOptional

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

500

Internal Server Error