---
title: "getJourney"
method: GET
path: "/v1/journey/configuration/{id}"
tags: ["Journeys"]
---

# getJourney

`GET /v1/journey/configuration/{id}`

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

## Path parameters

- `id` string, uuid, required

## Query parameters

- `version` integer
- `source` string
- `orgId` string

## Response `200`

Success

- object — Journeys read from the API always carry an explicit `settings.isActive`. The flag remains optional in request bodies.
  - `journeyId` string
  - `organizationId` string, required
  - `brandId` string
  - `name` string, required
  - `steps` object[], required
    - `showStepName` boolean, nullable
    - `title` string, nullable
    - `subTitle` string, nullable
    - `showStepSubtitle` boolean, nullable
    - `showStepper` boolean, nullable
    - `showStepperLabels` boolean, nullable
    - `stepperType` 'numbers' | 'progress bar'
    - `hideNextButton` boolean, nullable
    - `name` string, required
    - `stepId` string
    - `schema` unknown, required
    - `uischema` unknown, required
    - `maxWidth` 'small' | 'medium' | 'large' | 'extra large'
  - `design` object
    - `logoUrl` string, nullable
    - `theme` object
    - `designTokens` object
  - `rules` object[]
    - `type` 'inject' | 'injectWithKey', required
    - `sourceType` 'journey' | 'step' | 'block', required
    - `source` string, required
    - `target` string, required
  - `logics` object[]
    - `autoGeneratedId` string
    - `conditions` string[], required
    - `actions` string[], required
  - `logicsV4` object
  - `contextSchema` object[]
    - `id` string, uuid — Unique identifier for the context schema item
    - `type` string, required — Type of the parameter. It could be either an entity slug, or a text
    - `paramKey` string, required — Expected key to be received in the context
    - `isRequired` boolean — Indicates if a value is expected to be provided
    - `shouldLoadEntity` boolean — If type is not text, we can instruct the journey to fetch the entity id we receive as value
    - `description` string, nullable — Human-readable note describing the parameter's purpose. Free text; may contain newlines.
  - `journey_type` string — Journey Template
  - `protected` boolean — If true, journey is displayed in read-only mode
  - `protectedEditable` string[] — Whitelist of paths that remain editable when the journey is protected. Supports wildcard patterns (e.g. steps/*/blocks/**).
  - `settings` object, required
    - `embedOptions` object
      - `mode` 'full-screen' | 'inline'
      - `lang` 'de' | 'en' | 'fr'
      - `width` string
      - `topBar` boolean
      - `scrollToTop` boolean
      - `button` object
        - `text` string, nullable
        - `align` 'left' | 'center' | 'right'
    - `safeModeAutomation` boolean
    - `canary` boolean — DEPRECATED - This API will return hardcoded value of false. Please note that this field is internal to epilot and should not be used by external clients. If you wish to get the canary flag, please use the /v1/journey/{id}/settings API.
    - `designId` string, required
    - `templateId` string, nullable
    - `entityId` string, nullable
    - `mappingsAutomationId` string
    - `targetedCustomer` string
    - `description` string, nullable
    - `organizationSettings` object, nullable
    - `publicToken` string, nullable
    - `runtimeEntities` string[]
    - `filePurposes` string[]
    - `entityTags` string[]
    - `addressSuggestionsFileUrl` string, nullable — @deprecated Use addressSuggestionsFileId instead
    - `addressSuggestionsFileId` string, nullable
    - `addressSuggestionsCountryCode` string, nullable — Country code for address format (e.g. DE, AT, CH, LU)
    - `addressSuggestionsEnableAutoComplete` boolean — Whether address auto-complete is enabled
    - `addressSuggestionsSource` string[] — Sources for address auto-complete (e.g. deutschePostService, customAddressesFile)
    - `addressSuggestionsEnableFreeText` boolean — Whether free text input is allowed when auto-complete is on
    - `useNewDesign` boolean — This property is deprecated and will be removed in a future version
    - `useAustrianLabels` boolean — If true, some journey input labels are in Austrian format
    - `enableDarkMode` boolean — If true, the journey shows an icon to toggle dark mode
    - `accessMode` 'PUBLIC' | 'PRIVATE'
    - `authGate` object — Steps after this step require an authenticated session (auth gate)
      - `stepId` string, required — The step containing the Login & Registration block
    - `isPublished` boolean
    - `status` string
    - `isActive` boolean, required — Whether the journey is active (accessible to end customers)
    - `savingProgress` object
      - `mode` 'auto' | 'local' | 'remote' | 'none'
      - `supportedRevision` number
    - `thirdPartyCookies` boolean — If false, third-party cookies are disabled to comply with GDPR regulations without asking for consent.
  - `validationRules` ValidationRuleRef — 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).
  - `_manifest` string[] — Manifest/Blueprint ID used to create/update the entity
  - `createdBy` string
  - `updatedBy` string, nullable
  - `__lastModifiedAt` string, nullable — If passed with value of null, the API won't modify the lastModifiedAt field on updating the journey
  - `createdAt` string, required
  - `lastModifiedAt` string, required
  - `deletedAt` string
  - `version` number, required
  - `revisions` number, required
  - `featureFlags` object

## Changes

- **2026-08-26** `802039ced953` — 2 breaking, 1 info
  - response property `allOf[#/components/schemas/Journey]/allOf[#/components/schemas/JourneyCreationRequest]/validationRules/additionalProperties/oneOf[#/components/schemas/RuleRef]/additionalProperties/` list-of-types was widened by adding types `array` to media type `application/json` of response `200`
  - added `subschema #2` to the `allOf[#/components/schemas/Journey]/allOf[#/components/schemas/JourneyCreationRequest]/validationRules/additionalProperties/` response property `oneOf` list for the response status `200`
  - added the optional property `allOf[#/components/schemas/Journey]/allOf[#/components/schemas/JourneyCreationRequest]/settings/authGate` to the response with the `200` status
- **2026-08-20** `d19cdc961b84` — 1 info
  - added the optional property `allOf[#/components/schemas/Journey]/allOf[#/components/schemas/JourneyCreationRequest]/steps/items/stepperType` to the response with the `200` status
- **2026-08-12** `ebe46308269f` — 2 info
  - added `#/components/schemas/Journey, #/components/schemas/JourneyActivationGuarantee` to the response body `allOf` list for the response status `200`
  - removed `#/components/schemas/JourneyCreationRequest, #/components/schemas/JourneyAuditInfo, #/components/schemas/JourneyFeatureFlags` from the response body `allOf` list for the response status `200`
- …earlier changes not shown

[Full history](https://skmtc.dev/epilot/apis/journey-api/changes/v1/journey/configuration/:id/get.md)

---

[API](https://skmtc.dev/epilot/apis/journey-api.md) · [All operations](https://skmtc.dev/epilot/apis/journey-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/epilot/journey-api/revisions/802039ced953/schema)