Skip to content

Deel: Retrieve worker's actionable journeys — 200 response body — data item journey

Retrieve worker's actionable journeys: 200 response body, field data / item / journey. 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 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

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.