Sign in
Journeys

Fetch Journey

Fetch a Journey

get/api/v2/journeys/{id}

Path parameters

idstring uuid required
Example:69ae0e64b02bfe73a44ca479

Response

The request has succeeded.

idstring uuid required
transition_type'pre_offer' | 'offer' | 'post_offer' | 'onboarding' | 'offboarding' required
publishing_state'unpublished' | 'published' | 'draft' required
titlestring required
created_atstring iso8601 required

Example response

{
  "id": "69ae0e64b02bfe73a44ca479",
  "transition_type": "pre_offer",
  "publishing_state": "published",
  "created_at": "2026-02-01T01:02:03Z"
}

Changes

Changed in 4 of the 19 revisions of this API.382

  • 3f638e7bcdd418See the full diff
    • ▲

      for the path request parameter id, the type/format was changed from string/ to string/uuid

      request-parameter-type-changed

    • ●

      added the new draft enum value to the publishing_state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new offboarding enum value to the transition_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new offer enum value to the transition_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new onboarding enum value to the transition_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new post_offer enum value to the transition_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new pre_offer enum value to the transition_type response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new published enum value to the publishing_state response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new unpublished enum value to the publishing_state response property for the response status 200

      response-property-enum-value-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 33c1d595839511See the full diff
    • ▲

      removed the required property journey_type from the response with the 200 status

      response-required-property-removed

    • ○

      added the required property transition_type to the response with the 200 status

      response-required-property-added

  • 805744a185fa1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6cde27481f551See the full diff
    • ▲

      api path removed without deprecation

      api-path-removed-without-deprecation

    This revision also has 68 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog