Skip to main content
GET
Get campaign sequence

Authorizations

x-api-key
string
header
default:bd_live_your_key_here
required

Path Parameters

id
string
required

Query Parameters

format
enum<string>
default:graph

Response shape: graph (default, faithful/lossless), tree (nested branches), readable (human outline), or all.

Available options:
graph,
tree,
readable,
all

Response

The campaign sequence in the requested format

campaignId
string
required

The id of the campaign this sequence belongs to

Example:

"123e4567-e89b-12d3-a456-426614174000"

editorViewType
enum<string>
required

Which editor produced the campaign

Available options:
SIMPLE,
ADVANCED
Example:

"ADVANCED"

source
enum<string>
required

Where the sequence was read from: workflow (modern), legacy (old linear sequences), or empty (no sequence yet).

Available options:
workflow,
legacy,
empty
Example:

"workflow"

firstStep
number | null

Id of the first step to run, or null when there is no sequence

Example:

1

steps
object[]

Present when format is graph or all

tree
object | null

Present when format is tree or all. Nested step tree rooted at the first step; null for an empty sequence.

readable
string[]

Present when format is readable or all. One line per step/branch.

Example: