Journeys

Fetch a journey by id

Fetch a journey by id. Pass ?version=draft (default published) to retrieve the working draft, or ?version=vN to retrieve a historical version.

get/journeys/{templateId}

Request

Base URL
https://api.courier.com
Auth
HTTP bearer
TypeScript
https://skmtc.dev/trycourier/apis/courier/docs/journeys/:templateId/get.ts
A function with typed inputs. Its response is checked against the schema.

templateIdstring required

Journey id

versionstring

Version selector: draft, published (default), or vN.

Journey

idstring required

namestring required

state'DRAFT' | 'PUBLISHED' required

Lifecycle state of a journey.

enabledboolean required

createdinteger nullable required

creatorstring nullable required

updatedinteger nullable required

updaterstring nullable required

publishedinteger nullable required

Aug 3, 202604f69fbf96a5 Revision changes
- info
  added the optional property //// to the response with the status
Jul 6, 202679d88e927644 Revision changes
- breaking
  the response property //// became optional for the status
- info
  added the optional property /// to the response with the status