Skip to content

Deel: Learning schemas

12 Deel schemas with complete fields and constraints.

← Learning operations · All schemas

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 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 journey cover picture Cover Picture details for the Journey

FieldTypePresenceDescription and constraints
$objectRootCoverPicture details for the Journey
attachable_idstringOptionalID of the entity this attachment belongs to e.g. JourneyID
Format: uuid
attachable_typestringOptionalType of the entity this attachment belongs to e.g Journey
attachment_type_slugstringOptionalType of the attachment (e.g., cover_picture)
file_content_typestringOptionalContent type of the file
file_namestringOptionalName of the file
idstringOptionalUnique identifier of the CoverPicture Attachment
Format: uuid
urlstringOptionalURL to access the cover picture
Format: uri

Retrieve worker's actionable journeys — 200 response body — data item journey created by hris organization user profile

FieldTypePresenceDescription and constraints
$objectRootProfile of the user who created the journey
countryJSONOptional
country (anyOf 1)stringAlternativeCountry of the User
country (anyOf 2)nullAlternativeCountry of the User
deactivated_atJSONOptional
deactivated_at (anyOf 1)stringAlternativeDeactivation timestamp, if applicable
Format: date-time
deactivated_at (anyOf 2)nullAlternativeDeactivation timestamp, if applicable
Format: date-time
emailJSONOptional
email (anyOf 1)stringAlternativeEmail of the user who created the Journey
Format: email
email (anyOf 2)nullAlternativeEmail of the user who created the Journey
Format: email
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name of the User
first_name (anyOf 2)nullAlternativeFirst name of the User
hris_organization_user_idstringOptionalHRIS organization user ID
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title of the User
job_title (anyOf 2)nullAlternativeJob title of the User
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name of the User
last_name (anyOf 2)nullAlternativeLast name of the User
organization_public_idstringOptionalPublic ID of the organization
Format: uuid
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the profile picture
Format: uri
pic_url (anyOf 2)nullAlternativeURL of the profile picture
Format: uri
preferred_nameJSONOptional
preferred_name (anyOf 1)stringAlternativePreferred name of the User
preferred_name (anyOf 2)nullAlternativePreferred name of the User
typestringOptionalType of the User
Known values: WORKER, CLIENT
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email of the User
Format: email
work_email (anyOf 2)nullAlternativeWork email of the User
Format: email

Retrieve worker's actionable journeys — 200 response body — data item journey updated by hris organization user profile

FieldTypePresenceDescription and constraints
$objectRootProfile of the user who last updated the journey
countryJSONOptional
country (anyOf 1)stringAlternativeCountry of the User
country (anyOf 2)nullAlternativeCountry of the User
deactivated_atJSONOptional
deactivated_at (anyOf 1)stringAlternativeDeactivation timestamp, if applicable
Format: date-time
deactivated_at (anyOf 2)nullAlternativeDeactivation timestamp, if applicable
Format: date-time
emailJSONOptional
email (anyOf 1)stringAlternativeEmail of the user who last updated the journey
Format: email
email (anyOf 2)nullAlternativeEmail of the user who last updated the journey
Format: email
first_nameJSONOptional
first_name (anyOf 1)stringAlternativeFirst name of the User
first_name (anyOf 2)nullAlternativeFirst name of the User
hris_organization_user_idstringOptionalHRIS organization user ID
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title of the User
job_title (anyOf 2)nullAlternativeJob title of the User
last_nameJSONOptional
last_name (anyOf 1)stringAlternativeLast name of the User
last_name (anyOf 2)nullAlternativeLast name of the User
organization_public_idstringOptionalPublic ID of the organization
Format: uuid
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the profile picture
Format: uri
pic_url (anyOf 2)nullAlternativeURL of the profile picture
Format: uri
preferred_nameJSONOptional
preferred_name (anyOf 1)stringAlternativePreferred name of the User
preferred_name (anyOf 2)nullAlternativePreferred name of the User
typestringOptionalType of the User
Known values: WORKER, CLIENT
work_emailJSONOptional
work_email (anyOf 1)stringAlternativeWork email of the User
Format: email
work_email (anyOf 2)nullAlternativeWork email of the User
Format: email

Retrieve worker's actionable journeys — 200 response body — data item recipientable

FieldTypePresenceDescription and constraints
$objectRootRecipient 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.
countryJSONRequired within parent
country (anyOf 1)stringAlternativeCountry of the recipient
country (anyOf 2)nullAlternativeCountry of the recipient
deactivated_atJSONRequired within parent
deactivated_at (anyOf 1)stringAlternativeDeactivation timestamp of the recipient, if applicable
Format: date-time
deactivated_at (anyOf 2)nullAlternativeDeactivation timestamp of the recipient, if applicable
Format: date-time
emailstringRequired within parentEmail address of the recipient
Format: email
first_namestringRequired within parentFirst name of the recipient
hris_organization_user_idstringRequired within parentHRIS organization user ID of the recipient
Format: uuid
job_titleJSONRequired within parent
job_title (anyOf 1)stringAlternativeJob title of the recipient
job_title (anyOf 2)nullAlternativeJob title of the recipient
last_namestringRequired within parentLast name of the recipient
organization_public_idstringRequired within parentPublic ID of the organization the recipient belongs to
Format: uuid
pic_urlJSONRequired within parent
pic_url (anyOf 1)stringAlternativeURL of the profile picture of the recipient
Format: uri
pic_url (anyOf 2)nullAlternativeURL of the profile picture of the recipient
Format: uri
preferred_namestringRequired within parentPreferred name of the recipient
typestringRequired within parentType of the recipient User
Known values: WORKER, CLIENT
work_emailstringRequired within parentWork email of the recipient
Format: email

Retrieve worker's actionable journeys — 200 response body — data item scopeable

FieldTypePresenceDescription and constraints
$objectRootScopeable entity details e.g Assignment details
assignee_hris_organization_userModelRequired within parentExpand Retrieve worker's actionable journeys — 200 response body — data item scopeable assignee hris organization user
Details of the assigned user
idstringRequired within parentUnique identifier of the scopeable entity e.g AssignmentID
Format: uuid
is_self_assignedbooleanRequired within parentWhether the assignment was self-assigned

Referenced models: Retrieve worker's actionable journeys — 200 response body — data item scopeable assignee hris organization user

Retrieve worker's actionable journeys — 200 response body — data item scopeable assignee hris organization user

FieldTypePresenceDescription and constraints
$objectRootDetails of the assigned user
countryJSONOptional
country (anyOf 1)stringAlternativeCountry of the assignee
country (anyOf 2)nullAlternativeCountry of the assignee
deactivated_atJSONOptional
deactivated_at (anyOf 1)stringAlternativeDeactivation timestamp of the assignee, if applicable
Format: date-time
deactivated_at (anyOf 2)nullAlternativeDeactivation timestamp of the assignee, if applicable
Format: date-time
emailstringOptionalEmail address of the assignee
Format: email
first_namestringOptionalFirst name of the assignee
hris_organization_user_idstringOptionalHRIS organization user ID of the assignee
Format: uuid
job_titleJSONOptional
job_title (anyOf 1)stringAlternativeJob title of the assignee
job_title (anyOf 2)nullAlternativeJob title of the assignee
last_namestringOptionalLast name of the assignee
organization_public_idstringOptionalPublic ID of the organization the assignee belongs to
Format: uuid
pic_urlJSONOptional
pic_url (anyOf 1)stringAlternativeURL of the profile picture of the assignee
Format: uri
pic_url (anyOf 2)nullAlternativeURL of the profile picture of the assignee
Format: uri
preferred_namestringOptionalPreferred name of the assignee
typestringOptionalType of the assignee user
Known values: WORKER, CLIENT
work_emailstringOptionalWork email of the assignee
Format: email

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 step journey

FieldTypePresenceDescription and constraints
$objectRootBasic Journey information for the step
idstringOptionalUnique identifier of the Journey
Format: uuid
titlestringOptionalTitle of the journey

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.