# Journeys

Welcome to the Journeys API Documentation for Annex Cloud.

This comprehensive guide is designed to empower developers, marketers, and system integrators with the tools to craft dynamic, automated customer engagement flows within our loyalty platform. As a powerful engine for personalization, the Journeys API enables you to design and manage workflows triggered by user behaviors, events, or predefined conditions—ensuring timely and relevant interactions throughout the customer lifecycle.

 
Whether you're aiming to automate reward issuance, send personalized communications, or guide users through meaningful milestones, this documentation provides the foundational knowledge to help you build and optimize seamless customer journeys. We've created this guide to be intuitive for newcomers and insightful for experienced users, so you can confidently bring your engagement strategies to life.

The Journey API provides a powerful way for customers to access and understand the engagement paths that members follow within the platform. A journey represents a structured flow of interactions, such as earning points, receiving rewards, being enrolled in campaigns, or completing specific actions triggered by predefined events. These journeys are designed to enhance the member experience by guiding them through meaningful interactions with your brand.


 The API offers capabilities to retrieve both system-wide journey definitions and individual member-specific journey participation details. Customers can gain visibility into which journeys are currently active, how they are structured, and which members are part of them. This information can be used to monitor engagement, troubleshoot issues, personalize communication, and improve campaign effectiveness.

 
 By leveraging the Journey API, customers can -

 
 - View all configured journeys – Understand the journeys that exist within the platform, including their goals, triggers, and statuses.
 
 
 - Access detailed journey information – Drill down into specific journeys to see how they are configured and managed.
 
 
 - Track member-level participation – Retrieve data on which journeys a specific member is enrolled in, their progress, and any related events.
 
 
 - Support data-driven personalization – Use journey data to tailor messaging, offers, or experiences based on where a member is in their engagement lifecycle.
 
 
 - Enable efficient member support – Provide customer support teams with insights into a member's journey activity to help resolve inquiries more effectively.

## Get all user journeys

 - [GET /journeys](https://annexcloud.redocly.app/loyalty/loyalty/journeys/getjourneys.md): This API retrieves a list of all member journeys available for a site. Each journey represents a sequence of steps or processes that a member can follow, such as opting into a program or completing a specific flow. The response provides details such as the journey's name, description, status, creation information, and relevant metadata.

## Get journey details by journey ID

 - [GET /journeys/{{journey_id}}](https://annexcloud.redocly.app/loyalty/loyalty/journeys/getjourneysjourneyid.md): 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.

## Get User Journey specific details

 - [GET /user_journeys/{{email_id}}](https://annexcloud.redocly.app/loyalty/loyalty/journeys/getuserjourneysemailid.md): This endpoint retrieves a list of user journeys specifically associated with a member identified by their email address. A user journey represents a series of events, milestones, or actions that the member has completed within a system or platform—often tied to rewards, activities, or engagement workflows. This API enables businesses and developers to monitor user progress, assess engagement, and deliver personalized incentives based on the user's journey

## Get member specific User Journey

 - [GET /user/{{email_id}}/journeys](https://annexcloud.redocly.app/loyalty/loyalty/journeys/getuseremailidjourneys.md): This endpoint retrieves a list of user journey specifically associated with a member identified by their email Id. A journey represents a series of events, milestones, or actions that a member has completed within a given system or platform, often tied to rewards, activities, or engagement processes. This API allows businesses and developers to track member progress, measure engagement, and offer personalized incentives based on the user's journey