Skip to content

Deel: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data

Get onboarding details by onboarding tracker ID: 200 response body, field data / stepper / item / data. Complete fields and constraints for contract 2026-10-27.

API reference · Contract 2026-10-27

SDK schema: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data

FieldTypePresenceDescription and constraints
$objectRoot
completedJSONOptional
completed (anyOf 1)integerAlternativeChecklist steps completed, on the checklist progress step
completed (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
emailsarrayOptionalList of emails sent during the stepper process
emails[]ModelEach itemExpand Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails item
next_reminder_dateJSONOptional
next_reminder_date (anyOf 1)stringAlternativeNext reminder date, if applicable
Format: date-time
next_reminder_date (anyOf 2)nullAlternativeNext reminder date, if applicable
Format: date-time
onboarding_due_dateJSONOptional
onboarding_due_date (anyOf 1)stringAlternativeWhen onboarding is due, on the checklist progress step
Format: date-time
onboarding_due_date (anyOf 2)nullAlternativeWhen onboarding is due, on the checklist progress step
Format: date-time
remainingJSONOptional
remaining (anyOf 1)integerAlternativeChecklist steps remaining, on the checklist progress step
remaining (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
totalJSONOptional
total (anyOf 1)integerAlternativeChecklist steps in total, on the checklist progress step
total (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Referenced models: Get onboarding details by onboarding tracker ID — 200 response body — data stepper item data emails 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.