USuseboom
Journeys

Get journey definition

Changed on

Get a journey's full editable graph (all nodes, their config, and connections) so it can be modified and saved back. Unlike journeys_get, this is the complete authoring shape, not the sanitized public summary.

get/api/v1/journeys/{journeyId}/definition

Request

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

Path parameters

journeyIdstring required

A draft journey id, or the initiative id (resolves to its current draft).

Response

Success

idstring required

Journey (workflow version) id.

initiativeIdstring required

The initiative this journey belongs to.

status'DRAFT' | 'PUBLISHED' | 'STOPPED' required

DRAFT (editable), PUBLISHED (live, frozen), or STOPPED (retired).

versioninteger required

Version number within the initiative.

Changes

  • 7c7a773b12ceRevision changes
    • breaking

      added subschema #1 subschema #2 subschema #3 subschema #4 subschema #5 subschema #6 subschema #7 subschema #10 subschema #13 subschema #14 subschema #15 subschema #16 subschema #17 subschema #18 subschema #19 subschema #20 subschema #21 subschema #22 subschema #23 to the // response property oneOf list for the response status

    • info

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

    • info

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

    • info

      removed subschema #1 subschema #2 subschema #5 subschema #8 subschema #9 subschema #10 subschema #11 from the // response property oneOf list for the response status