Skip to main content
GET
Get a subsequence

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Subsequence id.

Example:

"5b2f3c4d-6e7f-4a81-9b0c-1d2e3f4a5b6c"

Response

id
string<uuid>
required
Example:

"5b2f3c4d-6e7f-4a81-9b0c-1d2e3f4a5b6c"

campaignId
string<uuid>
required

The campaign this subsequence belongs to.

Example:

"a7d4e2f1-08b3-4c65-9e7a-1b2c3d4e5f60"

name
string
required
Example:

"Interested - book a call"

position
integer
required

Order among the campaign's subsequences (1 = first): when one event matches several, the lead enters the first.

Example:

1

status
enum<string>
required

Lifecycle status, same vocabulary as campaigns: draft / paused = off, active = on.

Available options:
draft,
scheduled,
active,
paused,
stopped,
completed,
failed
Example:

"active"

enabled
boolean
required

Whether it is turned on (/enable / /pause). A subsequence of a draft campaign stays draft while on - it starts with the campaign.

Example:

true

state
enum<string>
required

Why it sends or not, in one word: draft - off; starts_with_campaign - on, starts when the draft campaign starts; active - on and sending; paused - paused by you; paused_with_campaign - on, but the campaign is paused; stopped_campaign_ended - the campaign completed, was stopped or deleted; paused_requires_plan - the plan does not include subsequences; cant_start - on, but it cannot start: it has no email, or an email is missing content; waiting_restart - on, waiting for the completed campaign to be restarted.

Available options:
draft,
starts_with_campaign,
active,
paused,
paused_with_campaign,
stopped_campaign_ended,
paused_requires_plan,
cant_start,
waiting_restart
Example:

"active"

settings
object
required
sequence
object[]
required

The emails of the subsequence - the same shape as a campaign's sequence. A step with an empty subject replies in the same thread.

counters
object
required

All-time counters (not limited to a period).

nextStartAt
string<date-time> | null
required

When the next waiting lead gets its first email; null when nobody is waiting.

createdAt
string<date-time>
required
Example:

"2026-10-28T08:00:00.000Z"