Journey Engine - Versions List

Endpoint

/o/journey-engine/versions/list

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

Overview

List all versions for a journey definition.

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

• journeyDefinitionId (required): Journey definition ID

Response

Success Response

[
  {
    "_id": "67164f4a1f1bd90d6354430b",
    "journeyDefinitionId": "67164f4a1f1bd90d6354430a",
    "version": 1,
    "name": "v1",
    "status": "draft",
    "blocks": [{"id": "block_1", "subType": "incoming-data"}],
    "appId": "64afe321d5f9b2f77cb2c8ed"
  }
]

Response Fields

Field	Type	Description
(root value)	Array	Journey version documents for the requested journey definition.
_id	String	Journey version ID.
journeyDefinitionId	String	Parent journey definition ID.
version	Number	Version number.
name	String	Version name, when stored.
blocks	Array	Journey block definitions for this version.
status	String	Version status such as draft, active, paused, or deleted.
appId	String	App ID.
skip_threshold	Number or Null	Optional user completion threshold for this version.

Error Responses

• 400: Invalid request
• 500: Query error

Examples

GET /o/journey-engine/versions/list?journeyDefinitionId=67164f4a1f1bd90d6354430a

Behavior/Processing

• Requires journeyDefinitionId; missing value returns Invalid request.
• Reads all matching documents from journey_versions with no status filter, so deleted versions can be returned.
• Does not sort explicitly; MongoDB natural order applies unless the stored collection/index order changes.

Database Collections

Collection	Used for	Data touched by this endpoint
countly.journey_versions	Endpoint data source	Stores endpoint-related records this endpoint reads or modifies.

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