EPepilot
Journeys

getJourney

Changed on

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

get/v1/journey/configuration/{id}

Request

  • Base URL
    https://journey-config.sls.epilot.io
  • URL
    https://journey-config.sls.epilot.io/v1/journey/configuration/{id}
  • Auth
    • none
    • or HTTP bearer
    • or HTTP bearer

Path parameters

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

Journey ID

Query parameters

versioninteger

Revision row to read. 0 (default) is the journey record, the published version every customer receives; a positive integer n reads revision row n (used by config-engine for history reads). Distinct from the revisions counter on the body, which is the legacy change counter of the published version. Versioning metadata is only available via publish-state.

revision_idstring
Example:42

Serve the named revision instead of the published version, so a save-and-continue session can stay on the revision it started on. Only revisions that have been published at least once are served on the public and portal routes; an unpublished revision is served to EpilotAuth callers with the edit permission and is otherwise unknown. Cannot be combined with the legacy version parameter.

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

blueprint_customizationobject

Blueprint field-locking contract (server-managed). Carries the author plane (locks, default level) and the org plane (server-derived overlay). Public writes never persist client-supplied values — the stored contract is authoritative; it is written only by the Blueprints install pipeline.

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

Revision row number of this item. 0 is the journey record, the published version.

revisionsnumber required

Legacy change counter of the published version, kept for compatibility: bumped whenever the published version changes and used for optimistic concurrency on PUT, by submissions (journey_context.journey_revision) and by save-and-continue. Saving a revision never changes it. Versioning metadata is only available via publish-state.

featureFlagsobject
revision_idstring

Example response

{
  "journey_type": "Sales template (Premium)",
  "settings": {
    "embedOptions": {
      "lang": "de"
    },
    "offline": {
      "packTtlHours": 24
    }
  },
  "validationRules": {
    "block1": "rule123",
    "block2": [
      "rule456",
      "rule789"
    ],
    "block3": {
      "field1": "rule101",
      "field2": [
        "rule102",
        "rule103"
      ]
    }
  },
  "_manifest": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "revision_id": "42"
}

Changes

  • 2f11eabb1f37Revision changes
    • info

      added the optional property ////////// to the response with the status

    • info

      added the optional property ///////// to the response with the status

  • c1595d30cd4fRevision changes
    • info

      added the optional property //////// to the response with the status