Skip to content

Deel: Get onboarding details by employee HRIS profile ID — 200 response body — data

Get onboarding details by employee HRIS profile ID: 200 response body, field data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Get onboarding details by employee HRIS profile ID — 200 response body — data

FieldTypePresenceDescription and constraints
$objectRoot
actionsarrayOptionalActions the caller can take on this onboarding
actions[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data actions item
app_experienceModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data app experience
The app experience of the employee
bannerJSONOptionalThe one thing worth saying about this worker, or null when there is nothing
banner (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO
banner (anyOf 2)nullAlternative
checklistModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data checklist
List of checklist steps
contractModelOptionalExpand Get onboarding details by employee HRIS profile ID — 200 response body — data contract
Information about the contract
contractsarrayOptionalEvery contract of the worker the caller can see, the main one first
contracts[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data contracts item
hiring_typestringOptionalHiring type (e.g., contractor)
hris_profileModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data hris profile
Employee HRIS profile information
profileJSONOptionalEmployee profile information
profile (anyOf 1)ModelAlternativeExpand Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information
profile (anyOf 2)nullAlternative
progressModelOptionalExpand Get onboarding details by onboarding tracker ID — 200 response body — data progress
Progress of the onboarding process
stepperarrayOptionalList of stepper actions taken during the onboarding process
stepper[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item
summaryarrayOptionalSummary of the onboarding process
summary[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data summary item

Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data actions item, Get onboarding details by onboarding tracker ID — 200 response body — data app experience, Get onboarding details by onboarding tracker ID — 200 response body — data / banner / severity: ERROR, WARNING, INFO, Get onboarding details by onboarding tracker ID — 200 response body — data checklist, Get onboarding details by onboarding tracker ID — 200 response body — data contracts item, Get onboarding details by onboarding tracker ID — 200 response body — data summary item, Get onboarding details by employee HRIS profile ID — 200 response body — data contract, Get onboarding details by onboarding tracker ID — 200 response body — data hris profile, Get onboarding details by onboarding tracker ID — 200 response body — data profile Employee profile information, Get onboarding details by onboarding tracker ID — 200 response body — data progress, Get onboarding details by onboarding tracker ID — 200 response body — data stepper item

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.