Journey Engine - List

Endpoint

/o/journey-engine/list

Ⓔ Enterprise Only
This API is available exclusively in Countly Enterprise.

Overview

List all journey definitions for an app, including versions and instance counts.

Authentication

• Authentication methods:
  • API Key (parameter): api_key=YOUR_API_KEY
  • Auth Token (parameter): auth_token=YOUR_AUTH_TOKEN
  • Auth Token (header): countly-token: YOUR_AUTH_TOKEN

Permissions

• Required permission: Read on the journey_engine feature

Request Parameters

• app_id (required): Application ID
• withDeletedJourneys (optional): When true, returns {active, deleted} lists

Response

Success Response

[
  {
    "_id": "67164f4a1f1bd90d6354430a",
    "name": "Onboarding Journey",
    "appId": "64afe321d5f9b2f77cb2c8ed",
    "status": "draft",
    "created": 1727101524294,
    "createdBy": "John Admin",
    "usersEntered": 1200,
    "flowsCompleted": 450,
    "versions": [
      {"_id": "67164f4a1f1bd90d6354430b", "version": 1, "created": 1727101524294}
    ]
  }
]

When withDeletedJourneys=true, the response is an object:

{
  "active": [
    {
      "_id": "67164f4a1f1bd90d6354430a",
      "name": "Onboarding Journey"
    }
  ],
  "deleted": [
    {
      "_id": "67164f4a1f1bd90d6354431f",
      "name": "Old Journey"
    }
  ]
}

Response Fields

Field	Type	Description
(root value)	Array or Object	Array of active journey definitions by default. Object with active and deleted arrays when withDeletedJourneys=true.
_id	String	Journey definition ID.
name	String	Journey definition name.
appId	String	App ID.
status	String	Journey definition status. Deleted definitions are excluded from the default response.
created	Number	Creation timestamp.
updated	Number	Last update timestamp, when stored.
createdBy	String or Null	Creator full name resolved from members; null when not available.
usersEntered	Number	Stored number of users that entered the journey. Defaults to 0.
flowsCompleted	Number	Stored number of completed flows. Defaults to 0.
versions	Array	Version summaries for the journey definition.
versions[].version	Number	Version number.
versions[].created	Number	Version creation timestamp.
versions[].blocks	Array	Version block definitions.
active	Array	Active/non-deleted journey definitions when withDeletedJourneys=true.
deleted	Array	Deleted journey definitions with their looked-up versions when withDeletedJourneys=true.

Error Responses

• 500: Query error

Examples

List active journeys

GET /o/journey-engine/list?app_id=64afe321d5f9b2f77cb2c8ed

Include deleted journeys

GET /o/journey-engine/list?app_id=64afe321d5f9b2f77cb2c8ed&withDeletedJourneys=true

Behavior/Processing

• Before listing, the handler patches deleted journeys that still have active versions by marking those versions as deleted.
• Journey definitions are loaded from journey_definition where appId matches and status is not deleted.
• Version summaries are loaded separately from journey_versions using the matching definition IDs.
• Creator names are resolved from members.full_name.
• Counts are stored in journey_definition documents and are not aggregated at query time for performance reasons.
• Results are sorted by status and then by newest created timestamp.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.journey_definition	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
countly.journey_versions	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.
countly.members	Member/account enrichment	Stores member profile fields (for example names/IDs) used to resolve actor metadata.

Related Endpoints

• No related endpoints

Ⓔ Enterprise

This feature is part of Countly Enterprise.

Get Access:

• Learn about Enterprise
• Contact Sales
• Compare Versions

Already a Customer? Use support portal if you have any questions

---

Last Updated

2026-04-18