Skip to content
Annex Cloud
/
Customer Loyalty
/
Journeys
/
Get all user journeys

Loyalty APIs (3.0.0)

Customer loyalty drives successful enterprises, representing the trust and emotional connection consumers develop with brands over time. In today's competitive landscape with evolving customer expectations, retaining existing customers is as crucial as attracting new ones. Our Customer Loyalty API revolutionizes customer engagement by enabling seamless integration of loyalty programs into your applications, websites, and platforms. This solution empowers businesses of all sizes with personalized experiences, targeted rewards, and data-driven insights to enhance customer lifetime value. This documentation guides you through integration with detailed explanations, endpoints, examples, and best practices suitable for both newcomers and experienced developers.

Key Features-

Customer Enrollment - Easily register customers with minimal API calls

Points and Rewards Management - Track points and incentivize engagement

Personalized Promotions - Create targeted offers based on individual preferences

Data Analytics - Gain insights into customer behavior for informed decisions

Security and Compliance - Protect customer data with robust security measures

Seamless Integration - Compatible with various platforms for hassle-free implementation

Download OpenAPI description
loyalty.json
loyalty.yaml
Languages
Servers

https://s15.socialannex.net/api/3.0/

Users

Welcome to the User API Documentation for Annex Cloud! This comprehensive guide is designed to empower developers, administrators, and system integrators with the knowledge and tools necessary to seamlessly interact with our loyalty platform's user-related functionalities. As the cornerstone of our customer engagement ecosystem, the Users API enables you to effortlessly manage user profiles, personalize experiences, and unlock the full potential of our loyalty solutions.

Whether you're aiming to integrate user registration into your application, retrieve user information for tailored experiences, or track user activity for insightful analytics, this documentation will serve as your compass in navigating the world of user management within our loyalty-based framework. We understand that your technical expertise is as unique as the experiences you aim to deliver to your users, and that's why we've crafted this guide to be both informative for newcomers and insightful for seasoned developers.

By leveraging the power of the User API, you'll gain the ability to create, update, and retrieve user profiles, harnessing valuable data to drive loyalty strategies and cultivate lasting relationships. From conceptual overviews to in-depth endpoints and practical examples, we've curated a resource that not only imparts technical know-how but also encourages innovation and creativity in building user-centric solutions.

Thank you for choosing Annex Cloud as your partner in loyalty solutions.

Operations

Points

Welcome to the Points API documentation for Annex Cloud, your gateway to unlocking a world of loyalty-based rewards and customer engagement. In this comprehensive guide, we'll walk you through the powerful capabilities of our Points API, designed to seamlessly integrate with your systems and empower you to create unforgettable experiences for your customers.

At Annex Cloud, we understand that building lasting relationships with your customers is at the core of your business. Our Points API provides you with the tools to effortlessly implement a robust loyalty program that not only drives customer retention but also enhances brand affinity. Whether you're a developer looking to integrate our API or a business leader seeking to harness the potential of loyalty rewards, this documentation will equip you with the knowledge and insights needed to succeed.

From awarding points for purchases and referrals to offering personalized rewards and exclusive perks, our Points API puts the control in your hands. With clear and concise endpoints, accompanied by code samples and real-world use cases, you'll be able to quickly grasp the API's functionality and start building innovative loyalty solutions that set you apart in today's competitive market.

Get ready to embark on a journey that goes beyond transactions. Let's dive into the intricacies of the Points API, where creativity meets technology to redefine the way you connect with your customers and drive sustainable business growth.

Operations

Action

Welcome to the Action API Documentation for Annex Cloud! We understand that crafting an exceptional loyalty program involves more than just rewarding points—it's about creating dynamic and engaging experiences for your customers. Our Loyalty Actions API is your gateway to elevating your loyalty program, allowing you to design and implement meaningful interactions that resonate with your audience. The Loyalty Actions API by Annex Cloud is a powerful tool designed to help you go beyond traditional loyalty rewards. With this API, you can:

Drive Customer Engagement- Create interactive and personalized experiences to keep your customers actively involved in your loyalty program.

Enable Real-time Interactions- Implement actions that trigger instantly based on customer behavior, ensuring timely and relevant rewards.

Enhance User Experience- Seamlessly integrate actions into your existing applications, websites, and platforms to provide a cohesive and enjoyable user experience.

Encourage Desired Behaviors- Design and deploy actions that align with your business objectives, encouraging customers to take specific actions that benefit both them and your brand.

At Annex Cloud, we believe in the power of meaningful interactions to strengthen the bond between your brand and your customers. This documentation is your key to unlocking the full potential of our Loyalty Actions API, and we're excited to embark on this journey with you. Thank you for choosing Annex Cloud to enhance your loyalty program, and let's create extraordinary experiences together! Let's get started!

Operations

Activity

Welcome to the Activity API documentation for Annex Cloud! Here, we are excited to guide you through the dynamic world of loyalty-based interactions and engagement. Our Activity API empowers you to seamlessly integrate and enhance your loyalty program with real-time activity tracking, enabling you to craft personalized experiences for your valued customers.

In this comprehensive guide, you will find everything you need to know to leverage the full potential of our Activity API. Whether you are a seasoned developer looking to integrate our API into your existing systems, or a business visionary seeking to create innovative loyalty solutions, we have got you covered.

From tracking points accumulation and rewards redemption to monitoring user interactions and crafting targeted campaigns, our Activity API opens doors to a new realm of customer engagement possibilities. We understand the significance of fostering lasting relationships with your clientele, and this API paves the way for fostering those connections in meaningful and profitable ways.

Through easy-to-follow examples, detailed endpoints, request and response formats, this documentation will empower you to harness the power of our Activity API effectively.

Explore the API, experiment with its capabilities, and unlock the potential to redefine loyalty experiences for your customers. The possibilities are boundless, and the rewards are waiting. Let us get started!

Operations

Tiers

Welcome to the Tiers API Documentation for Annex Clouds cutting-edge loyalty program platform. Our Tiers API empowers developers, businesses, and partners to seamlessly integrate and enhance their applications with our dynamic and customizable loyalty tiers system. This API documentation serves as your comprehensive guide to understanding and implementing the Tiers API, unlocking the full potential of loyalty-driven engagement for your customers.

Whether you are looking to reward long-term patrons, incentivize higher spending, or create personalized experiences for your member base, our Tiers API offers a versatile solution that aligns with your unique business goals. By integrating this API, you can effortlessly design and manage multi-tiered loyalty structures that captivate, engage, and retain your audience, all while enjoying the ease of integration and scalability that our platform provides.

Throughout this documentation, we will delve into the core functionalities of the Tiers API, walking you through the steps to seamlessly incorporate loyalty tiers into your applications. From setting up tier parameters and defining eligibility criteria, to handling tier transitions and leveraging tier-specific benefits, we have got you covered with clear instructions and code examples.

Operations

Rewards

At Annex Cloud, we understand the power of loyalty and the importance of rewarding your customers for their continued support. Our Loyalty Rewards API is designed to help you seamlessly integrate and enhance your loyalty program, making it easier than ever to create engaging, customized, and rewarding experiences for your customers. Using our Rewards API, you can easily access and utilize members' rewards data, allowing you to keep tabs on your loyal customer base, their preferences, and their engagement with your program. Additionally, you can access a comprehensive list of rewards used by your members, providing insights into what incentives are most appealing and effective.

This documentation covers everything you need to get started with our Loyalty Rewards API, including detailed information on available API endpoints and how to use them.

Thank you for choosing Annex Cloud for your loyalty needs, and we look forward to helping you build stronger, more loyal customer relationships.

Operations

Segment

Segment module can be used to differentiate the Users into groups which can be used in other loyalty modules for offers or campaigns. Define segments and conditions and use them to incentivize your members.

Operations

Campaign

Welcome to the Loyalty Program Campaigns API Documentation for Annex Cloud! This comprehensive guide is designed to empower developers, businesses, and stakeholders to seamlessly integrate and leverage our Loyalty Program Campaigns API within their applications and systems.

Our loyalty-based company understands the significance of fostering meaningful relationships with our valued customers. As such, we have crafted a powerful API that enables businesses to create, manage, and optimize loyalty campaigns, driving customer engagement, loyalty, and retention.

Annex Cloud’s Loyalty Program Campaigns API is a robust and flexible tool that facilitates the integration of our loyalty program capabilities into your applications and platforms. Through this API, you can design and execute diverse loyalty campaigns, offering tailored rewards and incentives to your customers based on their actions, purchases, or interactions with your brand.

By integrating our API, you unlock a plethora of benefits:

Customized Loyalty Campaigns: Design unique loyalty campaigns that align with your business goals and resonate with your customer base.

Enhanced Customer Engagement: Drive customer engagement by offering personalized rewards and promotions, enhancing their loyalty and advocacy.

Real-time Performance Insights: Obtain real-time analytics and insights into the performance of your loyalty campaigns, allowing you to optimize strategies for maximum effectiveness.

Seamless Integration: Easily integrate the Loyalty Program Campaigns API into your existing systems, ensuring a smooth and efficient loyalty program management process.

This documentation covers essential aspects, endpoints, request and response examples, and best practices to ensure a seamless integration and utilization of the Loyalty Program Campaigns API. Let's embark on this journey to elevate your loyalty programs and build lasting connections with your cherished customers.

Operations

Orders

Welcome to the Orders API documentation for Annex Cloud, where loyalty and seamless customer experiences converge. This API empowers developers, partners, and integrators to tap into the core of our loyalty-based ecosystem, enabling the creation of innovative and personalized solutions that enhance customer engagement and drive business growth.

In this comprehensive guide, you will find all the essential information needed to integrate with our Orders API seamlessly. Whether you're a seasoned developer seeking to leverage the power of loyalty data or a business owner aiming to enhance customer satisfaction, this documentation will serve as your compass to navigate the world of loyalty-driven transactions.

From placing orders and tracking purchases to utilizing loyalty rewards within the checkout process, the Orders API opens a realm of possibilities. By harnessing this interface, you can craft applications that bridge the gap between exceptional user experiences and business success.

We've designed this documentation to provide clear insights into the capabilities, endpoints, authentication, and best practices for utilizing the Orders API effectively. As you embark on this integration journey, we encourage you to explore the diverse use cases, reference implementations, and code snippets that will help you hit the ground running.

Thank you for choosing Annex Cloud as your partner in delivering unparalleled loyalty experiences. Let's dive into the intricacies of the Orders API and pave the way for loyalty-driven innovation that transforms the way customers interact with your brand.

Operations

BlockList

Welcome to Annex Cloud's Loyalty Blocklist API- a powerful tool designed to fortify the security and integrity of your loyalty program. In the dynamic landscape of customer engagement and rewards, ensuring the trustworthiness of your platform is paramount. Our Blocklist API is crafted to be the guardian of your loyalty ecosystem, providing a robust defense against fraudulent activities, unauthorized access, and other potential threats.

Elevate your loyalty program security with Annex Cloud's Loyalty Blocklist API.

Operations

Product

Welcome to the Annex Cloud Products API Documentation! We're excited to have you here as you explore the powerful tools and capabilities our Loyalty Program offers through this API.

At Annex Cloud, we understand the significance of fostering customer loyalty. Our mission is to help businesses like yours build lasting relationships with their customers by offering engaging and rewarding loyalty programs. Our Products API is a key component of this mission, allowing you to seamlessly integrate our loyalty features into your applications and systems.

This documentation is designed to be your comprehensive guide to using our Products API effectively. Whether you're a seasoned developer looking to dive into the technical details or a business owner seeking to enhance customer engagement, you'll find valuable information here to help you get started and make the most of our loyalty solutions.

To begin using our Products API, you'll need an API key and a clear understanding of how our endpoints work. We've organized this documentation into user-friendly sections, including:

Authentication: Learn how to securely authenticate your requests.

Endpoints: Explore the various API endpoints available and how to use them effectively.

Examples: Find practical examples and use cases to inspire your integration.

We're here to support you on your journey to building a more loyal customer base and boosting your business's success. If you have any questions or need assistance, please don't hesitate to reach out to our dedicated support team.

Thank you for choosing Annex Cloud as your partner in loyalty. Let's work together to create rewarding experiences for your customers.

Operations

Others

At Annex Cloud, we understand the diverse needs of our clients and the dynamic landscape of the loyalty industry. The Others API is crafted to cater to specific requirements that go beyond the standard functionalities, offering you flexibility and customization. Through strategic utilization of Store ID and Site ID, you gain the power to precisely identify and manage various aspects of your loyalty program across different stores and sites. We invite you to delve into the Others API and elevate your loyalty strategy to meet the specific needs of your audience and unlock new dimensions of customer engagement.

Operations

Survey

Welcome to the Survey API documentation for Annex Cloud! This comprehensive guide provides all the essential information and resources needed to integrate and interact with our survey platform programmatically. Our Survey API allows you to seamlessly integrate our powerful survey capabilities into your applications, websites, or systems. With this API, you can create, manage, and retrieve surveys, questions, responses, and more, empowering you to tailor survey experiences that align with your unique requirements. This documentation is designed to assist you in understanding how to leverage our API effectively, enabling you to:

Create Surveys: Dynamically generate surveys with specific questions and formats to suit your needs.

Retrieve Survey Data: Access survey responses and other relevant data for analysis or display.

Manage Surveys and Questions: Edit, delete, or modify existing surveys and questions to maintain an up-to-date and relevant survey structure.

Integrate Seamlessly: Integrate the survey capabilities seamlessly into your existing applications or platforms to collect valuable insights.

The subsequent sections will guide you through the necessary steps, providing examples and explanations to facilitate a smooth integration process.

Operations

Store

Welcome to the Store API documentation for Annex Cloud! We are thrilled to walk you through the exciting world of loyalty-based interactions and engagement. Our Store API allows you to seamlessly integrate and enhance your loyalty program by tracking real-time store details, enabling you to create personalized experiences for your valued customers.

The Store API is used to create stores in bulk, update the information of the created stores, and fetch all the details of the existing stores. Each store is identified by a unique store ID, which distinguishes it from other stores.

Operations

Hierarchy Management

Welcome to the Hierarchy Management API documentation for Annex Cloud! We are thrilled to walk you through the exciting world of loyalty-based interactions and engagement. Our Hierarchy Management API allows you to seamlessly integrate and enhance your loyalty program by tracking real-time Hierarchy Management details, enabling you to create personalized experiences for your valued customers.

The API methods covered in this document will enable you to create new groups, manage the activities of existing groups, and retrieve group details.

Operations

Issuance

Welcome to the Annex Cloud Issuance API documentation, where loyalty and seamless customer experiences converge. This comprehensive guide provides everything you need to seamlessly integrate with our transaction/issuance API. Whether you’re an experienced developer leveraging loyalty data or a business owner enhancing customer satisfaction, this documentation will guide you through the world of loyalty-driven transactions.

The Order API lacks the ability to handle specific dynamic attributes during order creation. To address this limitation, we have introduced the Issuance API, designed to store and process orders. Unlike the Order API, this new API does not include predefined calculations and mirrors the functionalities of the Order API.

Clients who would like to leverage more dynamic order attributes using the Issuance API will need to first calculate the points for spending and determine how members earn points. They will then send this value to our API, which should then accept it and grant the corresponding benefits based on the received payload.

Operations

Receipt

At Annex Cloud, we recognize the significance of loyalty and the value of rewarding your customers for their ongoing support. Our Loyalty Receipts API is designed to help you seamlessly integrate and enhance your loyalty program by enabling receipt upload, verification, and reward management, making it easier than ever to create engaging, customized, and rewarding experiences for your customers.

This documentation covers all aspects of the receipt upload and verification process. Once a receipt is successfully verified, members will earn points that they can redeem for coupons or use to purchase products based on their preferences.

Thank you for choosing Annex Cloud for your loyalty needs. We look forward to assisting you in building stronger and more loyal customer relationships.

Operations

Tiers V2

Welcome to the Tiers API Documentation for Annex Cloud's cutting-edge loyalty program platform. Our Tiers API empowers developers, businesses, and partners to seamlessly integrate and enhance their applications with our dynamic and customizable loyalty tiers system. This API documentation serves as your comprehensive guide to understanding and implementing the Tiers API, unlocking the full potential of loyalty-driven engagement for your customers. Whether you're looking to reward long-term patrons, incentivize higher spending, or create personalized experiences for your member base, our Tiers API offers a versatile solution that aligns with your unique business goals.

In this documentation, we will explore the core functionalities of the Tiers API.

We will guide you through the process of retrieving tier information configured within a program, understanding their entry conditions, and outlining the retention criteria.

Additionally, you will learn how to assign tiers to members based on your business requirements and needs.

Operations

Badges

The Badges API serves as an essential tool for modern customer engagement and gamification strategies, empowering businesses to design, manage, and track badge systems that motivate member behavior and recognize achievements. Its primary function is to facilitate the seamless retrieval, filtering, and categorization of badges, which can be used to enhance member experiences and foster loyalty through meaningful recognition and rewards. By integrating with this API, organizations can implement dynamic and personalized badge programs tailored to specific member actions and milestones.

In the broader context of gamification and engagement systems, the Badges API plays a critical role in driving member participation and retention. Badges act as visual representations of achievement and progress, encouraging members to interact more frequently with the platform and strive for higher goals. By leveraging the API's capabilities, businesses can design badge programs that align with their brand values and member expectations, fostering a sense of accomplishment and belonging. Personalized badges not only enhance the member's connection to the brand but also strengthen long-term loyalty, making the Badges API a cornerstone for creating compelling and effective engagement strategies.

Key features of the Badges API include the ability to retrieve badges based on various criteria such as status, group, member-specific progress, and attributes. It also supports sorting and pagination, allowing businesses to efficiently organize and display badges that align with their engagement goals. The API is designed with flexibility in mind, enabling developers to filter badges using a range of parameters, including member-specific statuses, group affiliations, and metadata attributes. This ensures that businesses can create tailored badge experiences that resonate with their audience.Key features of Annex Cloud’s Rewards API include the ability to list rewards based on specific criteria, retrieve detailed information about each reward, and assign rewards to members with ease. The API supports various data types and parameters for filtering rewards, ensuring that businesses can tailor their offerings to meet the unique needs of their customer base. Furthermore, the API includes robust error handling and validation mechanisms, which help maintain data integrity and improve overall system performance.

Operations

Rewards V2

The Rewards API serves as a crucial component of modern customer engagement strategies, enabling businesses to effectively manage and distribute rewards to their members. Its primary purpose is to facilitate the retrieval, assignment, and management of various rewards, which can significantly enhance user experience and drive customer loyalty. By providing a seamless integration with Reward systems, this API allows organizations to offer personalized incentives that cater to individual preferences and behaviors.

Key features of the Rewards API include the ability to list rewards based on specific criteria, retrieve detailed information about each reward, and assign rewards to members with ease. The API supports various data types and parameters for filtering rewards, ensuring that businesses can tailor their offerings to meet the unique needs of their customer base. Furthermore, the API includes robust error handling and validation mechanisms, which help maintain data integrity and improve overall system performance.

In the broader context of a rewards system, the Rewards API plays a pivotal role in fostering customer engagement. Rewards not only incentivize purchases but also encourage repeat interactions with the brand. By leveraging the capabilities of this API, businesses can create dynamic reward programs that resonate with members, thereby increasing customer satisfaction and retention. The ability to offer personalized rewards enhances the relevance of marketing efforts and strengthens the emotional connection between the brand and its customers, ultimately leading to higher conversion rates and improved brand loyalty.

Operations

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.

Operations

Get all user journeys

Request

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.

curl -i -X GET \
  https://s15.socialannex.net/api/3.0/journeys

Responses

Successfully retrieved the list of journeys.

Body
journeysArray of objects

Displays an array of journeys associated with the site.

metadataobject

Displays pagination details for the list of user journeys.

Response
{
  "journeys": [
    { … }
  ],
  "metadata": {
    "page": 1,
    "per_page": 10,
    "total_pages": 1,
    "total_count": 4
  }
}

Get journey details by journey ID

Request

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.

Path
journeyIdstringrequired

The unique identifier of the journey to retrieve.

curl -i -X GET \
  'https://s15.socialannex.net/api/3.0/journeys/{{journey_id}}'

Responses

Successfully retrieved the journey details.

Body
idstring

Displays the unique identifier for the user journey.

Example: "de04a64d-dc40-445f-8351-3dde7567d5c8"
site_idstring

Displays the unique identifier for the site associated with the journey.

Example: 9991331
multi_template_idstring

Displays the ID of the multi-template configuration, if applicable. If set to 0, it indicates no multi-template is applied.

Example: "0"
namestring

Displays the name of the journey, providing context or identifying the purpose of the journey.

Example: "User Journey 1"
descriptionstring

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_atstring or null

Displays the timestamp when the journey is published. If null, the journey has not yet been published.

Example: null
open_endedboolean

Displays whether the journey is open-ended (true) or has a defined entry condition (false).

Example: true
statusstring

Displays the current status of the journey such as Draft, Published, Archived.

Example: "Draft"
expired_atstring or null

Displays the timestamp when the journey expired. If null, the journey is ongoing or does not have an expiration date.

Example: null
start_datestring or null

Displays the start date of the journey, if defined.

Example: null
end_datestring or null

Displays the end date of the journey, if defined.

Example: null
created_bystring

Displays the ID of the member who created the journey. Useful for tracking ownership or audit purposes.

Example: "3"
created_atstring(date-time)

Displays the timestamp when the journey was created.

Example: "2025-01-15T10:33:32.500861"
updated_atstring(date-time)

Displays the timestamp when the journey was last updated.

Example: "2025-01-15T10:33:32.500861"
journey_nodesArray of objects

Displays an array of nodes within the journey.

journey_node_groupsstring

Displays groups of journey nodes. Empty if not grouped.

Response
{
  "id": "de04a64d-dc40-445f-8351-3dde7567d5c8",
  "site_id": 9991331,
  "multi_template_id": "0",
  "name": "User Journey 1",
  "description": "User Journey 1 - purpose and activities",
  "publish_at": null,
  "open_ended": true,
  "status": "Draft",
  "expired_at": null,
  "start_date": null,
  "end_date": null,
  "created_by": "3",
  "created_at": "2025-01-15T10:33:32.500861",
  "updated_at": "2025-01-15T10:33:32.500861",
  "journey_nodes": [
    { … }
  ],
  "journey_node_groups": "string"
}

Get User Journey specific details

Request

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

Path
email_idstringrequired

The email address of the user.

curl -i -X GET \
  'https://s15.socialannex.net/api/3.0/user_journeys/{{email_id}}'

Responses

Successfully retrieved user journey instances.

Body
journeysArray of objects

Displays the list of member journey instances associated with the provided email address.

metadataobject

Displays pagination details for the list of member journeys.

Response
{
  "journeys": [
    { … }
  ],
  "metadata": {
    "page": 1,
    "per_page": 10,
    "totalPages": 3,
    "total_count": 1
  }
}

Get member specific User Journey

Request

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

Path
email_idstringrequired

Enter the email ID of the user whose journeys are to be retrieved.

curl -i -X GET \
  'https://s15.socialannex.net/api/3.0/user/{{email_id}}/journeys'

Responses

A list of user journeys and their details.

Body
journeysArray of objects

Displays an array of journeys associated with the member.

metadataobject

Displays pagination details for the list of user journeys.

Response
{
  "journeys": [
    { … }
  ],
  "metadata": {
    "total_pages": 3,
    "current_page": 1,
    "per_page": 10
  }
}