USuseboom
Journeys

Get journey

Changed on

Get one journey by id — its trigger and the ordered steps people move through. Read-only, for inspecting setup.

get/api/v1/journeys/{journeyId}

Request

  • Base URL
    https://www.useboom.ai
  • Auth
    HTTP bearer

Path parameters

journeyIdstring required

Journey id.

Response

Success

idstring required

Journey id.

initiativeIdstring required

The initiative this journey belongs to.

namestring required

Journey name (from its initiative).

status'DRAFT' | 'ACTIVE' | 'ARCHIVED' required

DRAFT (still being configured), ACTIVE (live — people can move through it), or ARCHIVED (no longer running).

versioninteger required

Version number of the journey's current setup. Each time the steps are edited and re-activated, the version increases.

createdAtstring required

ISO 8601 timestamp.

updatedAtstring required

ISO 8601 timestamp.

Changes

  • 7c7a773b12ceRevision changes
    • warning

      added the new inbound enum value to the / response property for the response status

    • info

      added the required property / to the response with the status