SAsalesforge
Sequences

List sequence leads

Returns a page of leads enrolled in the sequence. Each item contains contact details, current enrollment state, and timeline steps in execution order. Pagination applies to leads, including when filtering by leadIds. Each lead includes its available timeline without separate pagination. Results default to the most recently updated enrollments. Date filters use inclusive UTC dates and apply to the timestamp selected by sortBy.

get/multichannel/workspaces/{workspaceID}/sequences/{sequenceID}/leads

Request

  • Base URL
    https://multichannel-api.salesforge.ai/public
  • Auth
    API key in header Authorization

Path parameters

workspaceIDstring required

Workspace ID

sequenceIDinteger required

Sequence ID

Query parameters

pageinteger

Page number

limitinteger

Items per page

statusstring

Enrollment status

qstring

Search lead name or email

openedEmailsOnlyboolean

Only leads with recorded email opens

in_subsequenceboolean

Only leads moved to a subsequence

leadIdsstring

Comma-separated lead IDs

sortBy'recently_contacted' | 'least_recently_contacted' | 'recently_updated' | 'recently_added' | 'oldest_added'

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

sortOrder'asc' | 'desc'

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

fromstring

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

tostring

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

Response

OK

Changes

No recorded changes to this operation across all 1 revision of this API.