Deel: Learning schemas
12 Deel schemas with complete fields and constraints.
← Learning operations · All schemas
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 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 journey cover picture Cover Picture details for the Journey
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | CoverPicture details for the Journey |
attachable_id | string | Optional | ID of the entity this attachment belongs to e.g. JourneyID Format: uuid |
attachable_type | string | Optional | Type of the entity this attachment belongs to e.g Journey |
attachment_type_slug | string | Optional | Type of the attachment (e.g., cover_picture) |
file_content_type | string | Optional | Content type of the file |
file_name | string | Optional | Name of the file |
id | string | Optional | Unique identifier of the CoverPicture Attachment Format: uuid |
url | string | Optional | URL to access the cover picture Format: uri |
Retrieve worker's actionable journeys — 200 response body — data item journey created by hris organization user profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Profile of the user who created the journey |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country of the User |
country (anyOf 2) | null | Alternative | Country of the User |
deactivated_at | JSON | Optional | |
deactivated_at (anyOf 1) | string | Alternative | Deactivation timestamp, if applicable Format: date-time |
deactivated_at (anyOf 2) | null | Alternative | Deactivation timestamp, if applicable Format: date-time |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email of the user who created the Journey Format: email |
email (anyOf 2) | null | Alternative | Email of the user who created the Journey Format: email |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name of the User |
first_name (anyOf 2) | null | Alternative | First name of the User |
hris_organization_user_id | string | Optional | HRIS organization user ID Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title of the User |
job_title (anyOf 2) | null | Alternative | Job title of the User |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name of the User |
last_name (anyOf 2) | null | Alternative | Last name of the User |
organization_public_id | string | Optional | Public ID of the organization Format: uuid |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the profile picture Format: uri |
pic_url (anyOf 2) | null | Alternative | URL of the profile picture Format: uri |
preferred_name | JSON | Optional | |
preferred_name (anyOf 1) | string | Alternative | Preferred name of the User |
preferred_name (anyOf 2) | null | Alternative | Preferred name of the User |
type | string | Optional | Type of the User Known values: WORKER, CLIENT |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email of the User Format: email |
work_email (anyOf 2) | null | Alternative | Work email of the User Format: email |
Retrieve worker's actionable journeys — 200 response body — data item journey updated by hris organization user profile
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Profile of the user who last updated the journey |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country of the User |
country (anyOf 2) | null | Alternative | Country of the User |
deactivated_at | JSON | Optional | |
deactivated_at (anyOf 1) | string | Alternative | Deactivation timestamp, if applicable Format: date-time |
deactivated_at (anyOf 2) | null | Alternative | Deactivation timestamp, if applicable Format: date-time |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email of the user who last updated the journey Format: email |
email (anyOf 2) | null | Alternative | Email of the user who last updated the journey Format: email |
first_name | JSON | Optional | |
first_name (anyOf 1) | string | Alternative | First name of the User |
first_name (anyOf 2) | null | Alternative | First name of the User |
hris_organization_user_id | string | Optional | HRIS organization user ID Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title of the User |
job_title (anyOf 2) | null | Alternative | Job title of the User |
last_name | JSON | Optional | |
last_name (anyOf 1) | string | Alternative | Last name of the User |
last_name (anyOf 2) | null | Alternative | Last name of the User |
organization_public_id | string | Optional | Public ID of the organization Format: uuid |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the profile picture Format: uri |
pic_url (anyOf 2) | null | Alternative | URL of the profile picture Format: uri |
preferred_name | JSON | Optional | |
preferred_name (anyOf 1) | string | Alternative | Preferred name of the User |
preferred_name (anyOf 2) | null | Alternative | Preferred name of the User |
type | string | Optional | Type of the User Known values: WORKER, CLIENT |
work_email | JSON | Optional | |
work_email (anyOf 1) | string | Alternative | Work email of the User Format: email |
work_email (anyOf 2) | null | Alternative | Work email of the User Format: email |
Retrieve worker's actionable journeys — 200 response body — data item recipientable
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | 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. |
country | JSON | Required within parent | |
country (anyOf 1) | string | Alternative | Country of the recipient |
country (anyOf 2) | null | Alternative | Country of the recipient |
deactivated_at | JSON | Required within parent | |
deactivated_at (anyOf 1) | string | Alternative | Deactivation timestamp of the recipient, if applicable Format: date-time |
deactivated_at (anyOf 2) | null | Alternative | Deactivation timestamp of the recipient, if applicable Format: date-time |
email | string | Required within parent | Email address of the recipient Format: email |
first_name | string | Required within parent | First name of the recipient |
hris_organization_user_id | string | Required within parent | HRIS organization user ID of the recipient Format: uuid |
job_title | JSON | Required within parent | |
job_title (anyOf 1) | string | Alternative | Job title of the recipient |
job_title (anyOf 2) | null | Alternative | Job title of the recipient |
last_name | string | Required within parent | Last name of the recipient |
organization_public_id | string | Required within parent | Public ID of the organization the recipient belongs to Format: uuid |
pic_url | JSON | Required within parent | |
pic_url (anyOf 1) | string | Alternative | URL of the profile picture of the recipient Format: uri |
pic_url (anyOf 2) | null | Alternative | URL of the profile picture of the recipient Format: uri |
preferred_name | string | Required within parent | Preferred name of the recipient |
type | string | Required within parent | Type of the recipient User Known values: WORKER, CLIENT |
work_email | string | Required within parent | Work email of the recipient Format: email |
Retrieve worker's actionable journeys — 200 response body — data item scopeable
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Scopeable entity details e.g Assignment details |
assignee_hris_organization_user | Model | Required within parent | Expand Retrieve worker's actionable journeys — 200 response body — data item scopeable assignee hris organization user Details of the assigned user |
id | string | Required within parent | Unique identifier of the scopeable entity e.g AssignmentID Format: uuid |
is_self_assigned | boolean | Required within parent | Whether 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
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Details of the assigned user |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Country of the assignee |
country (anyOf 2) | null | Alternative | Country of the assignee |
deactivated_at | JSON | Optional | |
deactivated_at (anyOf 1) | string | Alternative | Deactivation timestamp of the assignee, if applicable Format: date-time |
deactivated_at (anyOf 2) | null | Alternative | Deactivation timestamp of the assignee, if applicable Format: date-time |
email | string | Optional | Email address of the assignee Format: email |
first_name | string | Optional | First name of the assignee |
hris_organization_user_id | string | Optional | HRIS organization user ID of the assignee Format: uuid |
job_title | JSON | Optional | |
job_title (anyOf 1) | string | Alternative | Job title of the assignee |
job_title (anyOf 2) | null | Alternative | Job title of the assignee |
last_name | string | Optional | Last name of the assignee |
organization_public_id | string | Optional | Public ID of the organization the assignee belongs to Format: uuid |
pic_url | JSON | Optional | |
pic_url (anyOf 1) | string | Alternative | URL of the profile picture of the assignee Format: uri |
pic_url (anyOf 2) | null | Alternative | URL of the profile picture of the assignee Format: uri |
preferred_name | string | Optional | Preferred name of the assignee |
type | string | Optional | Type of the assignee user Known values: WORKER, CLIENT |
work_email | string | Optional | Work email of the assignee Format: email |
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 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 |