Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Sequence Contacts

List contacts in sequence

<small>Requires the sequences:read scope (or a broader one that includes it).</small>

Retrieve all contacts enrolled in the sequence. Defaults to most-recently-added first; use sort_by and sort_direction to override.

get/v3/sequences/{id}/contacts

Path parameters

idinteger required

Sequence ID

Query parameters

topinteger

Maximum number of items to return (default 25, max 1000)

skipinteger

Number of items to skip

sort_by'addingDate' | 'email' | 'firstName' | 'lastName' | 'company' | 'statusInSequence'

Field name to sort results by. Each value matches the corresponding response field. When omitted, results are ordered most-recently-added first.

sort_direction'asc' | 'desc'

Sort direction (asc or desc). Defaults to desc when sort_by is provided.

Response

List of contacts in sequence

hasMoreboolean

Indicates if there are more items to fetch

Example response

{
  "items": [
    {
      "contactId": 12345,
      "sequenceId": 100,
      "email": "john.doe@company.com",
      "firstName": "John",
      "lastName": "Doe",
      "company": "Tech Solutions Inc",
      "title": "Senior Product Manager",
      "statusInSequence": "active",
      "isOptedOut": false,
      "callStatus": "none",
      "meetingStatus": "none",
      "emailDisposition": {
        "isReplied": false,
        "isBounced": false
      },
      "currentStep": {
        "stepId": 5421,
        "displayName": "2"
      },
      "addingDate": "2024-03-08T10:00:00+00:00",
      "emailAccountId": 101,
      "linkedInAccountId": null
    }
  ]
}