Sign in

v3

latestOpenAPI 3.0.02026-07-31162156.9 KB
Journeys

getJourney

Get journey by id. Private journeys requires valid private token to be passed

get/v1/journey/configuration/{id}

Path parameters

idstring uuid required
Example:509cdffe-424f-457a-95c2-9708c304ce77

Journey ID

Query parameters

versioninteger

DynamoDB version to fetch. 0 (default) is the live row; positive integers are historical snapshots created on each save. Note: this is distinct from the revisions counter on the row body.

sourcestring

What source ID. Journey or Entity ID

orgIdstring

Organization ID

Response

Success

journeyIdstring
organizationIdstring required
brandIdstring
namestring required
logicsV4object
journey_typestring

Journey Template

protectedboolean

If true, journey is displayed in read-only mode

protectedEditablestring[]

Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).

validationRulesValidationRuleRef

References to validation rules organized by blocks and fields. Maps block IDs to either rule IDs (for block-level rules) or rule references (for field-level rules).

_manifeststring[]

Manifest/Blueprint ID used to create/update the entity

createdBystring
updatedBystring nullable
__lastModifiedAtstring nullable

If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey

createdAtstring required
lastModifiedAtstring required
deletedAtstring
versionnumber required
revisionsnumber required
featureFlagsobject

Example response

{
  "journey_type": "Sales template (Premium)",
  "validationRules": {
    "block1": "rule123",
    "block2": {
      "field1": "rule456",
      "field2": "rule789"
    }
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}