# Get journey details by journey ID

The purpose of this endpoint is to provide detailed information about a specific journey within the system. Journeys are structured workflows or paths that define how members interact with the platform. Each journey is composed of various nodes (steps or actions) and their connections, representing the flow of member activities or system events. Note - If a member performs a blocking event during the hold period, the parameters hold_start_datetime and hold_end_datetime will not be displayed. Instead, blocked_by and blocked_at will be shown, and the reward status will be marked as blocked.
Note: For all date-time fields in the request and response, if the timestamp contains a timezone offset after the + symbol (for example, 2024-07-21T12:30:45+05:30), the value after + will be ignored during processing. Only the date and time portion before the + sign will be considered.

Endpoint: GET /journeys/{{journey_id}}
Version: 3.0.0
Security: MuseumPlaceholderAuth

## Path parameters:

  - `journeyId` (string, required)
    The unique identifier of the journey to retrieve.

## Response 200 fields (application/json):

  - `id` (string)
    Displays the unique identifier for the user journey.
    Example: de04a64d-dc40-445f-8351-3dde7567d5c8

  - `site_id` (string)
    Displays the unique identifier for the site associated with the journey.
    Example: 9991331

  - `multi_template_id` (string)
    Displays the ID of the multi-template configuration, if applicable. If set to 0, it indicates no multi-template is applied.
    Example: 0

  - `name` (string)
    Displays the name of the journey, providing context or identifying the purpose of the journey.
    Example: User Journey 1

  - `description` (string)
    Displays a brief explanation of the journey’s purpose. For instance, "User Journey" describes a general-purpose journey for member actions.
    Example: User Journey 1 - purpose and activities

  - `publish_at` (string)
    Displays the timestamp when the journey is published. If null, the journey has not yet been published.
    Example: null

  - `open_ended` (boolean)
    Displays whether the journey is open-ended (true) or has a defined entry condition (false).
    Example: true

  - `status` (string)
    Displays the current status of the journey such as Draft, Published, Archived.
    Example: Draft

  - `expired_at` (string)
    Displays the timestamp when the journey expired. If null, the journey is ongoing or does not have an expiration date.
    Example: null

  - `start_date` (string)
    Displays the start date of the journey, if defined.
    Example: null

  - `end_date` (string)
    Displays the end date of the journey, if defined.
    Example: null

  - `created_by` (string)
    Displays the ID of the member who created the journey. Useful for tracking ownership or audit purposes.
    Example: 3

  - `created_at` (string)
    Displays the timestamp when the journey was created.
    Example: 2025-01-15T10:33:32.500861

  - `updated_at` (string)
    Displays the timestamp when the journey was last updated.
    Example: 2025-01-15T10:33:32.500861

  - `journey_nodes` (array)
    Displays an array of nodes within the journey.

  - `journey_nodes.id` (string)
    Displays the unique identifier of the node.
    Example: a2494f66-71d8-423f-9156-6ed9a879dae6

  - `journey_nodes.journey_group_id` (string)
    Displays the unique identifier of the journey group to which the node belongs.
    Example: null

  - `journey_nodes.title` (string)
    Displays the name of the node.
    Example: apievents

  - `journey_nodes.category` (string)
    Displays the category of the node.
    Example: EntryExit

  - `journey_nodes.type` (string)
    Displays the specific type of the node. For instance, "Entry" indicates the beginning of the journey.
    Example: Entry/ Points

  - `journey_nodes.created_at` (string)
    Displays the create date in YYYY-MM-DDTHH:MM:SS format.
    Example: 2025-05-27T13:58:54

  - `journey_nodes.updated_at` (string)
    Displays the update date in YYYY-MM-DDTHH:MM:SS format.
    Example: 2025-05-27T13:58:54

  - `journey_nodes.data(In General Scenario)` (object)
    Displays additional metadata associated with the node. NOTE- The responses below change based on the type of node defined.

  - `journey_nodes.data(In General Scenario).label` (string)
    Displays a descriptive label for the node, such as "open".
    Example: Open

  - `journey_nodes.data(In General Scenario).entry_type` (string)
    Displays the entry type, e.g., "OpenEnded", indicating the node is open-ended.
    Example: OpenEnded

  - `journey_nodes.data(In General Scenario).frequency` (integer)
    Displays how many times a specific entry event must occur within the specified duration for the journey to proceed.
    Example: 2

  - `journey_nodes.data(In General Scenario).duration` (string)
    Displays the time window (e.g., day, week, month) during which the number of event occurrences (defined by frequency) must be met.
    Example: week

  - `journey_nodes.data(In General Scenario).unordered` (boolean)
    Displays true if the events in the group can be completed in any order.
    Example: true

  - `journey_nodes.data(In General Scenario).repeat_count` (integer)
    Displays the number of times the group must be completed before the journey proceeds.
    Example: 2

  - `journey_nodes.data(In General Scenario).track_counts` (string)
    Displays the method of tracking event completion.
    Example: Cumulative

  - `journey_nodes.data(In General Scenario).is_time_constraint` (boolean)
    Displays whether there is a time constraint for completing the event group.
    Example: false

  - `journey_nodes.data(In General Scenario).time_constraint` (string)
    Displays the time limit for completing the event group, if any.

  - `journey_nodes.data(When reward hold days are applied to the process)` (object)
    Displays additional metadata associated with the node. NOTE- The responses below change based on the type of node defined.

  - `journey_nodes.data(When reward hold days are applied to the process).label` (string)
    Displays a descriptive label for the node, such as "open".
    Example: Open

  - `journey_nodes.data(When reward hold days are applied to the process).entry_type` (string)
    Displays the entry type, e.g., "OpenEnded", indicating the node is open-ended.
    Example: OpenEnded

  - `journey_nodes.data(When reward hold days are applied to the process).frequency` (integer)
    Displays how many times a specific entry event must occur within the specified duration for the journey to proceed.
    Example: 2

  - `journey_nodes.data(When reward hold days are applied to the process).duration` (string)
    Displays the time window (e.g., day, week, month) during which the number of event occurrences (defined by frequency) must be met.
    Example: week

  - `journey_nodes.data(When reward hold days are applied to the process).unordered` (boolean)
    Displays true if the events in the group can be completed in any order.
    Example: true

  - `journey_nodes.data(When reward hold days are applied to the process).reward_id` (string)
    Displays the reward ID associated with the journey.
    Example: 102733699

  - `journey_nodes.data(When reward hold days are applied to the process).is_additional_rules` (string)
    Displays whether the additional rules (such as hold days and blocking events) are enabled or not. If enabled, it shows true; otherwise, this parameter is not displayed.
    Example: true

  - `journey_nodes.data(When reward hold days are applied to the process).repeat_count` (integer)
    Displays the number of times the group must be completed before the journey proceeds.
    Example: 2

  - `journey_nodes.data(When reward hold days are applied to the process).track_counts` (string)
    Displays the method of tracking event completion.
    Example: Cumulative

  - `journey_nodes.data(When reward hold days are applied to the process).is_time_constraint` (boolean)
    Displays whether there is a time constraint for completing the event group.
    Example: false

  - `journey_nodes.data(When reward hold days are applied to the process).time_constraint` (string)
    Displays the time limit for completing the event group, if any.

  - `journey_nodes.data(When the points node is applied after the action)` (object)
    Displays additional metadata associated with the node. NOTE- The responses below change based on the type of node defined.

  - `journey_nodes.data(When the points node is applied after the action).label` (string)
    Displays the custom label assigned to the Points Node for identification within the journey.
    Example: pt

  - `journey_nodes.data(When the points node is applied after the action).points_action_id` (string)
    Displays the action ID used to define the type of points operation (used for awarding points).
    Example: 7575

  - `journey_nodes.data(When the points node is applied after the action).points` (integer)
    Displays the number of points to be awarded to the member when the node is triggered.
    Example: 100

  - `journey_nodes.data(When the points node is applied after the action).is_expiration_selected` (string)
    Displays whether the expiration setting for points is enabled or not. If enabled, it shows true; otherwise, this parameter will not be displayed.
    Example: true

  - `journey_nodes.data(When the points node is applied after the action).expiration_type` (string)
    Displays the type of expiration applied to the awarded points. Possible values include rolling or calendar.
    Example: calendar

  - `journey_nodes.data(When the points node is applied after the action).expiration_rolling_value` (integer)
    Displays the number of days after which points expire in case of rolling expiration type.
    Example: 10

  - `journey_nodes.data(When the points node is applied after the action).expiration_calendar_value` (string)
    Displays the calendar unit used for expiration in calendar type, such as Month or Year.
    Example: Year

  - `journey_nodes.data(When the points node is applied after the action).expiration_calendar_count` (string)
    Displays the number of calendar units after which the points will expire.
    Example: 8

  - `journey_nodes.data(When the points node is applied after the action).reason` (string)
    Displays the reason or description for awarding the points, useful for audit and tracking purposes.
    Example: Reward for completing journey action

  - `journey_nodes.conditions` (object)
    Displays the conditions or rules applied to the node. An empty object indicates no conditions.

  - `journey_nodes.conditions.hold_days` (integer)
    Displays the number of days the reward will remain on hold.
    Example: 2

  - `journey_nodes.conditions.blocking_actions` (array)
    Displays the IDs of the actions selected to be blocked during the hold period. If any of these actions are performed within the hold days, the reward will be permanently blocked.
    Example: 148,107

  - `journey_nodes.journey_node_connections` (array)
    Displays connections to other nodes within the journey.

  - `journey_nodes.journey_node_connections.id` (string)
    Unique identifier for the connection.
    Example: 8d62502c-0e35-4c4a-8bd2-e3314c00ae4e

  - `journey_nodes.journey_node_connections.journey_node_id` (string)
    ID of the current node.
    Example: a2494f66-71d8-423f-9156-6ed9a879dae6

  - `journey_nodes.journey_node_connections.journey_parent_id` (string)
    ID of the parent node. Null if it's a starting node.
    Example: null

  - `journey_node_groups` (string)
    Displays groups of journey nodes. Empty if not grouped.