v1

latestOpenAPI 3.0.32026-07-26737274.2 KB
Sequences

List sequences

Returns every sequence on the account. A sequence is a self-contained set of automated emails — subscribers join, then receive each email in order, governed by per-email delay_value / delay_unit and the sequence's overall send_days, send_hour, and time_zone schedule.

Each entry carries the schedule defaults plus three behavioural toggles: active (whether the sequence is delivering), repeat (whether subscribers can re-enter), and hold (whether subscribers stay active after receiving every published email — an evergreen pattern). See Create a sequence for the full sequence model.

Once you have a sequence's id, List sequence emails returns the individual emails inside it.

For end-user context on how creators build sequences, see the help articles on creating and sending a sequence and evergreen content.

get/v4/sequences

Query parameters

{"stackTrail":"paths:/v4/sequences:get:parameters:0:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch next page of results, use ?after=<end_cursor>

{"stackTrail":"paths:/v4/sequences:get:parameters:1:schema","oasType":"schema","type":"unknown","nullable":true}

To fetch previous page of results, use ?before=<start_cursor>

include_total_countboolean

Set to true to include the total_count in the response. This option can cause slow responses; if paging through results, request it only on the first page and reuse the value for subsequent pages.

{"stackTrail":"paths:/v4/sequences:get:parameters:3:schema","oasType":"schema","type":"unknown","nullable":true}

Number of results per page. Default 500, maximum 1000.

includestring

Comma-separated list of additional data to include on each sequence. Valid options: stats. stats adds a stats object with deliverability counts and rates (opens, clicks, bounces, complaints, unsubscribes) plus the unsubscriber count, matching the numbers shown on the sequences dashboard.

Response

Returns a paginated list of all sequences for your account