Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Sequence Contacts

List contacts in sequence with extended state

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

Retrieve contacts enrolled in the sequence with optional additional columns such as current step, last step completed at, and status.

The response always includes the base fields: contactId, email, firstName, lastName, title, addedAt. Additional fields (currentStep, lastStepCompletedAt, status) are only included when explicitly requested via the additionalColumns query parameter. Omitting additionalColumns returns only the base fields.

get/v3/sequences/{id}/contacts/state

Path parameters

idinteger required

Sequence ID

Query parameters

topinteger

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

skipinteger

Number of items to skip

additionalColumnsstring

Comma-separated list of additional columns to include in the response. When omitted, only base fields are returned.

ColumnDescription
CurrentStepCurrent sequence step info (stepId, displayStepNumber, stepNumber)
LastStepCompletedAtTimestamp of the last completed step
StatusEngagement status with delivery/open/click/reply/bounce flags

Example: additionalColumns=CurrentStep,Status

Response

List of contacts with extended state data

hasMoreboolean

Indicates if there are more items to fetch

Example response

{
  "items": [
    {
      "contactId": 150467348,
      "email": "john.doe@example.com",
      "firstName": "John",
      "lastName": "Doe",
      "title": "Important Client",
      "addedAt": "2025-10-29T10:00:00.00",
      "currentStep": {
        "stepId": 11111111,
        "displayStepNumber": "1",
        "stepNumber": 1
      },
      "lastStepCompletedAt": null,
      "status": {
        "status": "Active",
        "replied": false,
        "delivered": false,
        "bounced": false,
        "opened": false,
        "clicked": false
      }
    }
  ]
}