List Sequences

Authorizations

Authorization

string

header

required

Bearer API key issued from Settings → Developers.

Query Parameters

page

integer

default:1

Page number.

Required range: x >= 1

size

integer

default:10

Number of items per page.

Required range: 1 <= x <= 100

sort_by

enum<string> | null

Field to sort by.

Available options:

created_at,

updated_at,

status

sort_order

enum<string>

default:asc

Sort direction.

Available options:

asc,

desc

sequence_template_id

string<uuid> | null

Filter by template.

contact_id

string<uuid> | null

Filter by the contact the sequence targets.

status

enum<string> | null

Filter by status.

Available options:

ACTIVE,

SUCCEEDED,

FAILED,

COMPLETED,

WAITING_FOR_LEAD,

WAITING_FOR_USER,

STOPPED_EARLY,

FOUND,

REFUSED

created_at_before

string<date-time> | null

Return sequences created strictly before this timestamp.

created_at_after

string<date-time> | null

Return sequences created strictly after this timestamp.

Response

200 - application/json

Successful Response

items

SequencePublicOutput · object[]

required

Records on this page.

Hide child attributes

items.id

string<uuid>

required

Unique identifier.

items.organization_id

string<uuid>

required

Workspace this sequence belongs to.

items.contact_id

string<uuid> | null

required

Contact this sequence is targeting.

items.sequence_template_id

string<uuid>

required

Template the sequence was instantiated from.

items.status

enum<string>

required

Current execution state.

Available options:

ACTIVE,

SUCCEEDED,

FAILED,

COMPLETED,

WAITING_FOR_LEAD,

WAITING_FOR_USER,

STOPPED_EARLY,

FOUND,

REFUSED

items.variables

Variables · object | null

required

Per-run template variables substituted into outbound messages.

Hide child attributes

items.variables.{key}

string | null

items.source_contact_list_id

string<uuid> | null

required

Contact list that triggered this sequence, if any.

items.last_step_executed_at

string<date-time> | null

required

When the most recent step ran.

items.created_at

string<date-time>

required

When the sequence was created.

items.updated_at

string<date-time>

required

When the sequence last changed.

items.contact

PublicContactSummary · object | null

Summary of the contact this sequence is targeting.

Hide child attributes

items.contact.id

string<uuid>

required

Unique identifier of the contact.

items.contact.first_name

string | null

First name.

items.contact.last_name

string | null

Last name.

items.contact.email

string | null

Email.

items.contact.linkedin_url

string | null

LinkedIn profile URL.

items.contact.job_title

string | null

Job title.

items.contact.company_name

string | null

Employer name.

items.contact.company_domain

string | null

Employer's primary domain.

items.sequence_template

PublicSequenceTemplateSummary · object | null

Summary of the template this sequence was instantiated from.

Hide child attributes

items.sequence_template.id

string<uuid>

required

Unique identifier of the sequence template.

items.sequence_template.name

string

required

Template name.

total_count

integer

required

Total number of records matching the query.

total_pages

integer

required

Total number of pages.

has_more

boolean

required

Whether more pages remain after the current one.

Overview

Users

Contacts

Accounts

Sequences & Tasks

Events & Webhooks

List Sequences

Authorizations

Query Parameters

Response