Sign in
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 one or more ordered 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": [
      "rule456",
      "rule789"
    ],
    "block3": {
      "field1": "rule101",
      "field2": [
        "rule102",
        "rule103"
      ]
    }
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

Changes

Changed in 5 of the 6 revisions of this API.327

  • 802039ced95321See the full diff
    • ▲

      response property allOf[Journey]/allOf[JourneyCreationRequest]/validationRules/additionalProperties/oneOf[RuleRef]/additionalProperties/ list-of-types was widened by adding types array to media type application/json of response 200

      response-property-list-of-types-widened

    • ▲

      added subschema #2 to the allOf[Journey]/allOf[JourneyCreationRequest]/validationRules/additionalProperties/ response property oneOf list for the response status 200

      response-property-one-of-added

    • ○

      added the optional property allOf[Journey]/allOf[JourneyCreationRequest]/settings/authGate to the response with the 200 status

      response-optional-property-added

  • d19cdc961b841See the full diff
    • ○

      added the optional property allOf[Journey]/allOf[JourneyCreationRequest]/steps/items/stepperType to the response with the 200 status

      response-optional-property-added

  • ebe46308269f2See the full diff
    • ○

      added Journey JourneyActivationGuarantee to the response body allOf list for the response status 200

      response-body-all-of-added

    • ○

      removed JourneyCreationRequest JourneyAuditInfo JourneyFeatureFlags from the response body allOf list for the response status 200

      response-body-all-of-removed

  • 515acb1f892e23See the full diff
    • ●

      removed the optional property allOf[JourneyCreationRequest]/settings/savingProgress/savingMode from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property allOf[JourneyCreationRequest]/settings/savingProgress/supportedVersion from the response with the 200 status

      response-optional-property-removed

    • ○

      added the optional property allOf[JourneyCreationRequest]/contextSchema/items/description to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[JourneyCreationRequest]/settings/savingProgress/mode to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property allOf[JourneyCreationRequest]/settings/savingProgress/supportedRevision to the response with the 200 status

      response-optional-property-added

  • 8927efbc8b6d1See the full diff
    • ▲

      the response property allOf[JourneyCreationRequest]/settings/templateId became nullable for the status 200

      response-property-became-nullable