Sign in
Sequences

List sequence recipients

Lists enrolled people for a sequence. Requires a USER API key.

get/public/v1/sequences/{sequenceId}/recipients

Path parameters

sequenceIdnumber nullable
Example:101

Query parameters

filterTextstring
Example:example
'ACTIVE' | 'WAITING' | 'PAUSED' | 'COMPLETED' | 'EXITED' | 'FAILED' | 'REMOVED'
OR
'ACTIVE_GROUP'
OR
'ALL'
Example:ACTIVE
pageNumnumber
Example:1
pageSizenumber
Example:1

Response

Paginated recipient list

countnumber
pageSizenumber required
pageNumnumber
totalPagesnumber
cursornumber
paginationType'offset' | 'cursor'

Example response

{
  "count": 1,
  "pageSize": 1,
  "pageNum": 1,
  "totalPages": 1,
  "cursor": 1,
  "results": [
    {
      "instance": {
        "id": 1,
        "accountId": 1,
        "sequenceId": 1,
        "personRowId": "example",
        "snapshotId": "example",
        "sourceSnapshotId": "example",
        "snapshotPinnedAt": "example",
        "currentNodeId": "example",
        "status": "ACTIVE",
        "blockedOn": "NONE",
        "nextExecutionAt": "example",
        "enrolledByUserId": 1,
        "senderConnectedAccountId": 1,
        "startedAt": "example",
        "lastAdvancedAt": "example",
        "exitedAt": "example",
        "completedAt": "example",
        "pausedAt": "example",
        "removedAt": "example",
        "exitReason": "example",
        "exitNote": "example",
        "exitedByUserId": 1,
        "failureReason": "example",
        "failureCode": "example",
        "createdAt": "example",
        "updatedAt": "example",
        "enrolledByUser": {
          "id": 1,
          "firstName": "example",
          "lastName": "example",
          "email": "user@example.com",
          "avatar": "example"
        },
        "exitedByUser": {
          "id": 1,
          "firstName": "example",
          "lastName": "example",
          "email": "user@example.com",
          "avatar": "example"
        }
      },
      "person": {
        "rowId": "example",
        "fullName": "example",
        "email": "example",
        "avatar": "example"
      },
      "statusLabel": "example",
      "exitReason": {
        "code": "example",
        "label": "example"
      },
      "exitNote": "example",
      "exitedAt": "example",
      "exitedBy": {
        "id": 1,
        "firstName": "example",
        "lastName": "example",
        "email": "user@example.com",
        "avatar": "example"
      },
      "lastActivityAt": "example",
      "nextActionLabel": "example"
    }
  ],
  "paginationType": "offset",
  "nextCursor": "example"
}

Changes

Changed in 1 of the 2 revisions of this API.1