Skip to content

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.

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 os
from alter_sdk import App
from 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()
FieldTypePresenceDescription and constraints
$objectRootAdditional keys: not allowed
queryobjectOptionalAdditional keys: not allowed
query.journey_idsarrayOptional
query.journey_ids[]stringEach itemFormat: uuid
query.journey_assignment_idsarrayOptional
query.journey_assignment_ids[]stringEach itemFormat: uuid
query.limitintegerOptionalDefault: 50
Maximum: 100
Minimum: 1
query.cursorstringOptional

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

FieldTypePresenceDescription and constraints
$ModelRootExpand Retrieve worker’s actionable journeys — 200 response body

Referenced models: Retrieve worker’s actionable journeys — 200 response body

6 more schemas are linked from the tables above, on the schema pages.

Retrieve worker's actionable journeys — 200 response body
FieldTypePresenceDescription and constraints
$objectRootActionableJourney 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.
dataarrayRequired within parent
data[]ModelEach itemExpand Retrieve worker's actionable journeys — 200 response body — data item
next_cursorJSONRequired within parent
next_cursor (anyOf 1)stringAlternativeCursor to fetch the next page of results. Null if no more pages.
next_cursor (anyOf 2)nullAlternativeCursor 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
FieldTypePresenceDescription and constraints
$objectRootActionableJourney item
actionable_pathstringRequired within parentPath to redirect User for starting/resuming the Actionable Journey.
completed_journey_steps_countJSONRequired within parent
completed_journey_steps_count (anyOf 1)integerAlternativeNumber of Journey Steps the worker has completed so far.
Minimum: 0
completed_journey_steps_count (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
completionModelRequired within parentExpand Retrieve worker's actionable journeys — 200 response body — data item completion
Completion status of the Journey
journeyModelRequired within parentExpand Retrieve worker's actionable journeys — 200 response body — data item journey
Journey details
recipient_setting_dynamic_role_idJSONRequired within parent
recipient_setting_dynamic_role_id (anyOf 1)stringAlternativeDynamic role/relationship ID for RecipientSetting.
recipient_setting_dynamic_role_id (anyOf 2)nullAlternativeDynamic role/relationship ID for RecipientSetting.
recipient_setting_dynamic_role_nameJSONRequired within parent
recipient_setting_dynamic_role_name (anyOf 1)stringAlternativeDynamic role name for RecipientSetting
recipient_setting_dynamic_role_name (anyOf 2)nullAlternativeDynamic role name for RecipientSetting
recipient_setting_typeJSONRequired within parentType of RecipientSetting. e.g Manager, Buddy etc.
recipient_setting_type (anyOf 1)stringAlternativeType of RecipientSetting. e.g Manager, Buddy etc.
Known values: hris_organization_user, manager, buddy, mentor
recipient_setting_type (anyOf 2)nullAlternative
recipientableModelRequired within parentExpand 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.
scopeableModelRequired within parentExpand Retrieve worker's actionable journeys — 200 response body — data item scopeable
Scopeable entity details e.g Assignment details
stepModelRequired within parentExpand Retrieve worker's actionable journeys — 200 response body — data item step
Step details
total_journey_steps_countJSONRequired within parent
total_journey_steps_count (anyOf 1)integerAlternativeTotal number of Journey Steps in this Journey.
Minimum: 0
total_journey_steps_count (anyOf 2)stringAlternativePattern: ^-?[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
FieldTypePresenceDescription and constraints
$objectRootStep details
idstringRequired within parentUnique identifier of the Step
Format: uuid
journeyModelRequired within parentExpand Retrieve worker's actionable journeys — 200 response body — data item step journey
Basic Journey information for the step
journey_idstringRequired within parentID 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
FieldTypePresenceDescription and constraints
$objectRootCompletion status of the Journey
percentageJSONRequired within parent
percentage (anyOf 1)numberAlternativeCompletion percentage of the Journey
Format: double
Maximum: 100
Minimum: 0
percentage (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
Retrieve worker's actionable journeys — 200 response body — data item journey
FieldTypePresenceDescription and constraints
$objectRootJourney details
cover_pictureJSONOptionalCoverPicture details for the Journey
cover_picture (anyOf 1)ModelAlternativeExpand Retrieve worker's actionable journeys — 200 response body — data item journey cover picture Cover Picture details for the Journey
cover_picture (anyOf 2)nullAlternative
created_atstringRequired within parentThe timestamp when the Journey was created
Format: date-time
created_by_hris_organization_user_profileModelRequired within parentExpand 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
descriptionJSONRequired within parent
description (anyOf 1)stringAlternativeDescription of the Journey
description (anyOf 2)nullAlternativeDescription of the Journey
draft_for_idJSONRequired within parent
draft_for_id (anyOf 1)stringAlternativeIf 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)nullAlternativeIf this is draft for an existing Journey, draft_for_id is the reference to the original Journey ID.
Format: uuid
idstringRequired within parentUnique identifier of the journey
Format: uuid
is_self_assignment_allowedbooleanRequired within parentWhether self-assignment is allowed for this Journey
is_templatebooleanRequired within parentWhether the Journey is a template
is_time_basedbooleanRequired within parentWhether the Journey is time-based
is_visible_in_librarybooleanRequired within parentWhether the Journey is visible in the library
organization_idJSONRequired within parent
organization_id (anyOf 1)integerAlternativeThe organizationID this Journey belongs to
organization_id (anyOf 2)stringAlternativePattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
published_atstringRequired within parentThe timestamp when the Journey was published
Format: date-time
recently_edited_atstringRequired within parentThe timestamp when the Journey was recently edited
Format: date-time
titlestringRequired within parentTitle of the journey
type_slugstringRequired within parentThe type slug of the Journey e.g default, Scorm
updated_atstringRequired within parentThe timestamp when the Journey was last updated
Format: date-time
updated_by_hris_organization_user_profileModelRequired within parentExpand 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_slugstringRequired within parentThe 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
FieldTypePresenceDescription and constraints
$objectRootBasic Journey information for the step
idstringOptionalUnique identifier of the Journey
Format: uuid
titlestringOptionalTitle of the journey

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"}

Official provider source

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.