v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Contacts

Get sequences for a contact

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

Use this endpoint when you need to see which sequences a contact is enrolled in, together with each sequence's name, the contact's status in it, the current step, and when they were added.

get/v3/contacts/{id}/sequences

Path parameters

idinteger required

Contact ID

Response

Contact sequences retrieved successfully

sequenceIdinteger
sequenceNamestring
statusInSequence'active' | 'paused' | 'finished' | 'outOfOffice'

Workflow status of the contact within this sequence

addingDatestring date-time nullable
emailAccountIdinteger nullable
linkedInAccountIdinteger nullable

Example response

[
  {
    "currentStep": {
      "stepId": 5821,
      "displayName": "Email step 2"
    }
  }
]