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

API reference · Contract 2026-10-27

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

Field	Type	Presence	Description and constraints
$	object	Root	Checklist step information
category	JSON	Optional
category (anyOf 1)	string	Alternative	Heading the step sits under
category (anyOf 2)	null	Alternative	Heading the step sits under
category_key	JSON	Optional
category_key (anyOf 1)	string	Alternative	Stable identifier of the heading, which keeps its value when the heading is renamed
category_key (anyOf 2)	null	Alternative	Stable identifier of the heading, which keeps its value when the heading is renamed
completed_at	JSON	Optional
completed_at (anyOf 1)	string	Alternative	Completion timestamp of the checklist step Format: date-time
completed_at (anyOf 2)	null	Alternative	Completion timestamp of the checklist step Format: date-time
data	object	Optional	Details of the step, which vary by step Additional keys: see wildcard field
data.*	JSON	Additional keys	Any type
description	string	Optional	What the step asks of the worker
display_key	JSON	Optional
display_key (anyOf 1)	string	Alternative	Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry
display_key (anyOf 2)	null	Alternative	Stable identifier of the step, the same across every worker type. Null when the step has no catalogue entry
due_date	JSON	Optional
due_date (anyOf 1)	string	Alternative	When the step is due, when the source carries one Format: date-time
due_date (anyOf 2)	null	Alternative	When the step is due, when the source carries one Format: date-time
group	string	Optional	Whether the worker still owes the step Known values: COMPLETED, OUTSTANDING
label	string	Optional	The label for the checklist step
ordinal	JSON	Optional
ordinal (anyOf 1)	integer	Alternative	Position of the step in the onboarding sequence, starting at one
ordinal (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
reject_reason	string	Optional	Reason for rejecting the checklist step (It may contain HTML elements)
state	string	Optional	State of the step, reported the same way for every worker type Known values: NOT_STARTED, IN_PROGRESS, IN_REVIEW, COMPLETED, OVERDUE
status	string	Optional	Status of the checklist step
type	string	Optional	The type of checklist step