Deel: Retrieve worker's actionable journeys — 200 response body — data item
Retrieve worker's actionable journeys: 200 response body, field data / item. Complete fields and constraints for contract 2026-10-27.
API reference · Contract 2026-10-27
SDK schema: Retrieve worker's actionable journeys — 200 response body — data item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | ActionableJourney item |
actionable_path | string | Required within parent | Path to redirect User for starting/resuming the Actionable Journey. |
completed_journey_steps_count | JSON | Required within parent | |
completed_journey_steps_count (anyOf 1) | integer | Alternative | Number of Journey Steps the worker has completed so far. Minimum: 0 |
completed_journey_steps_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
completion | Model | Required within parent | Expand Retrieve worker’s actionable journeys — 200 response body — data item completion Completion status of the Journey |
journey | Model | Required within parent | Expand Retrieve worker’s actionable journeys — 200 response body — data item journey Journey details |
recipient_setting_dynamic_role_id | JSON | Required within parent | |
recipient_setting_dynamic_role_id (anyOf 1) | string | Alternative | Dynamic role/relationship ID for RecipientSetting. |
recipient_setting_dynamic_role_id (anyOf 2) | null | Alternative | Dynamic role/relationship ID for RecipientSetting. |
recipient_setting_dynamic_role_name | JSON | Required within parent | |
recipient_setting_dynamic_role_name (anyOf 1) | string | Alternative | Dynamic role name for RecipientSetting |
recipient_setting_dynamic_role_name (anyOf 2) | null | Alternative | Dynamic role name for RecipientSetting |
recipient_setting_type | JSON | Required within parent | Type of RecipientSetting. e.g Manager, Buddy etc. |
recipient_setting_type (anyOf 1) | string | Alternative | Type of RecipientSetting. e.g Manager, Buddy etc. Known values: hris_organization_user, manager, buddy, mentor |
recipient_setting_type (anyOf 2) | null | Alternative | |
recipientable | Model | Required within parent | Expand Retrieve worker’s actionable journeys — 200 response body — data item recipientable Recipient for the ActionableJourney Step. Used in conjunction with recipient_setting_type. Recipient can be the same user as Assignee or any other user e.g Manager or Accounts Lead based on the RecipientSetting for the Step. |
scopeable | Model | Required within parent | Expand Retrieve worker’s actionable journeys — 200 response body — data item scopeable Scopeable entity details e.g Assignment details |
step | Model | Required within parent | Expand Retrieve worker’s actionable journeys — 200 response body — data item step Step details |
total_journey_steps_count | JSON | Required within parent | |
total_journey_steps_count (anyOf 1) | integer | Alternative | Total number of Journey Steps in this Journey. Minimum: 0 |
total_journey_steps_count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Referenced models: Retrieve worker’s actionable journeys — 200 response body — data item step, Retrieve worker’s actionable journeys — 200 response body — data item completion, Retrieve worker’s actionable journeys — 200 response body — data item journey, Retrieve worker’s actionable journeys — 200 response body — data item recipientable, Retrieve worker’s actionable journeys — 200 response body — data item scopeable