Deel: Retrieve worker's actionable journeys
Deel learning.retrieveWorkersActionableJourneys: arguments, response, policy and SDK examples.
← Learning operations · Get started
Operation deel.learning_retrieveworkersactionablejourneys_v2026_01_01
Provider route: GET /engage/learning/actionable-journeys. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “Call through Alter”Install @alter-ai/sdk @alter-ai/deel with npm, or alter-sdk-deel with pip. Supply your connected customer’s grant ID and the arguments described below.
import { App } from "@alter-ai/sdk";import { DeelIntegration } from "@alter-ai/deel";
async function execute(input: Parameters<DeelIntegration["learning"]["retrieveWorkersActionableJourneys"]>[0]) { const app = new App({ apiKey: process.env.ALTER_API_KEY! }); try { const provider = new DeelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! }); const call = await provider.learning.retrieveWorkersActionableJourneys(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom alter_sdk_deel import DeelIntegration
async def execute(arguments): async with App(api_key=os.environ["ALTER_API_KEY"]) as app: provider = DeelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]}) call = await provider.learning.retrieve_workers_actionable_journeys(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
query | object | Optional | Additional keys: not allowed |
query.journey_ids | array | Optional | |
query.journey_ids[] | string | Each item | Format: uuid |
query.journey_assignment_ids | array | Optional | |
query.journey_assignment_ids[] | string | Each item | Format: uuid |
query.limit | integer | Optional | Default: 50 Maximum: 100 Minimum: 1 |
query.cursor | string | Optional |
Response
Section titled “Response”Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | Model | Root | Expand Retrieve worker’s actionable journeys — 200 response body |
Referenced models: Retrieve worker’s actionable journeys — 200 response body
Schemas
Section titled “Schemas”6 more schemas are linked from the tables above, on the schema pages.
Retrieve worker's actionable journeys — 200 response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | ActionableJourney is a representation of a JourneyAssignment and JourneyStep. This defines which Worker should be acting on which Step of the Journey. Generally, it would be same as Assignee of the JourneyAssignment, but can be different when RecipientSettings are added to Steps. |
data | array | Required within parent | |
data[] | Model | Each item | Expand Retrieve worker's actionable journeys — 200 response body — data item |
next_cursor | JSON | Required within parent | |
next_cursor (anyOf 1) | string | Alternative | Cursor to fetch the next page of results. Null if no more pages. |
next_cursor (anyOf 2) | null | Alternative | Cursor to fetch the next page of results. Null if no more pages. |
Referenced models: Retrieve worker's actionable journeys — 200 response body — data item
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
Retrieve worker's actionable journeys — 200 response body — data item step
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Step details |
id | string | Required within parent | Unique identifier of the Step Format: uuid |
journey | Model | Required within parent | Expand Retrieve worker's actionable journeys — 200 response body — data item step journey Basic Journey information for the step |
journey_id | string | Required within parent | ID of the Journey this step belongs to Format: uuid |
Referenced models: Retrieve worker's actionable journeys — 200 response body — data item step journey
Retrieve worker's actionable journeys — 200 response body — data item completion
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Completion status of the Journey |
percentage | JSON | Required within parent | |
percentage (anyOf 1) | number | Alternative | Completion percentage of the Journey Format: double Maximum: 100 Minimum: 0 |
percentage (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Retrieve worker's actionable journeys — 200 response body — data item journey
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Journey details |
cover_picture | JSON | Optional | CoverPicture details for the Journey |
cover_picture (anyOf 1) | Model | Alternative | Expand Retrieve worker's actionable journeys — 200 response body — data item journey cover picture Cover Picture details for the Journey |
cover_picture (anyOf 2) | null | Alternative | |
created_at | string | Required within parent | The timestamp when the Journey was created Format: date-time |
created_by_hris_organization_user_profile | Model | Required within parent | Expand Retrieve worker's actionable journeys — 200 response body — data item journey created by hris organization user profile Profile of the user who created the journey |
description | JSON | Required within parent | |
description (anyOf 1) | string | Alternative | Description of the Journey |
description (anyOf 2) | null | Alternative | Description of the Journey |
draft_for_id | JSON | Required within parent | |
draft_for_id (anyOf 1) | string | Alternative | If this is draft for an existing Journey, draft_for_id is the reference to the original Journey ID. Format: uuid |
draft_for_id (anyOf 2) | null | Alternative | If this is draft for an existing Journey, draft_for_id is the reference to the original Journey ID. Format: uuid |
id | string | Required within parent | Unique identifier of the journey Format: uuid |
is_self_assignment_allowed | boolean | Required within parent | Whether self-assignment is allowed for this Journey |
is_template | boolean | Required within parent | Whether the Journey is a template |
is_time_based | boolean | Required within parent | Whether the Journey is time-based |
is_visible_in_library | boolean | Required within parent | Whether the Journey is visible in the library |
organization_id | JSON | Required within parent | |
organization_id (anyOf 1) | integer | Alternative | The organizationID this Journey belongs to |
organization_id (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
published_at | string | Required within parent | The timestamp when the Journey was published Format: date-time |
recently_edited_at | string | Required within parent | The timestamp when the Journey was recently edited Format: date-time |
title | string | Required within parent | Title of the journey |
type_slug | string | Required within parent | The type slug of the Journey e.g default, Scorm |
updated_at | string | Required within parent | The timestamp when the Journey was last updated Format: date-time |
updated_by_hris_organization_user_profile | Model | Required within parent | Expand Retrieve worker's actionable journeys — 200 response body — data item journey updated by hris organization user profile Profile of the user who last updated the journey |
visibility_slug | string | Required within parent | The visibility setting of the Journey Known values: organization, public, private-marketplace |
Referenced models: Retrieve worker's actionable journeys — 200 response body — data item journey cover picture Cover Picture details for the Journey, Retrieve worker's actionable journeys — 200 response body — data item journey created by hris organization user profile, Retrieve worker's actionable journeys — 200 response body — data item journey updated by hris organization user profile
Retrieve worker's actionable journeys — 200 response body — data item step journey
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Basic Journey information for the step |
id | string | Optional | Unique identifier of the Journey Format: uuid |
title | string | Optional | Title of the journey |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: deel.learning_retrieveworkersactionablejourneys_v2026_01_01. Catalog operation: learning_retrieveworkersactionablejourneys_v2026_01_01. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.
Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.
Required provider scopes: ["worker:read"]
Pinned headers: {"X-Version": "2026-01-01"}