Skip to main content
GET
List sequence leads

Authorizations

Authorization
string
header
required

Path Parameters

workspaceID
string
required

Workspace ID

sequenceID
integer
required

Sequence ID

Required range: 1 <= x <= 2147483647

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
limit
integer
default:20

Items per page

Required range: 1 <= x <= 100
status
string

Enrollment status

q
string

Search lead name or email

openedEmailsOnly
boolean

Only leads with recorded email opens

in_subsequence
boolean

Only leads moved to a subsequence

leadIds
string

Comma-separated lead IDs

sortBy
enum<string>
default:recently_updated

Sort by enrollment update, enrollment creation, or contact activity; also selects the timestamp used by from and to

Available options:
recently_contacted,
least_recently_contacted,
recently_updated,
recently_added,
oldest_added
sortOrder
enum<string>

Sort direction; defaults to desc. least_recently_contacted and oldest_added always use asc

Available options:
asc,
desc
from
string

Inclusive start date in UTC (YYYY-MM-DD); requires to

to
string

Inclusive end date in UTC (YYYY-MM-DD); requires from

Response

OK

leads
object[]
required
pagination
object
required