v93

latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-01218121759.7 KB
Sequences

List sequence enrollments

Lists the individual contacts enrolled in one sequence, with the node each one is currently sitting on. Defaults to active and waiting enrollments. Use this when sequence stats give you enrollmentCounts and you need the actual subscribers behind a number.

get/sequences/{sequenceId}/enrollments

Path parameters

sequenceIdstring required

Sequence ID

Query parameters

statusstring

Comma-separated enrollment statuses: active, waiting, completed, failed, cancelled. Defaults to active,waiting.

currentNodeIdstring

Comma-separated sequence node IDs. Only enrollments currently sitting on one of these nodes are returned.

subscriberIdstring

Comma-separated subscriber IDs.

emailstring

Exact email address to match, case-insensitive.

sort'enrolled_at_desc' | 'enrolled_at_asc' | 'wait_until_asc' | 'wait_until_desc'

Result order. Defaults to enrolled_at_desc. Enrollments with no scheduled resume sort last under wait_until ordering.

limitinteger

Enrollments per page. Values above 500 are capped.

offsetinteger

Number of enrollments to skip. Page until pagination.hasMore is false.

Response

Enrollments matching the filters

successboolean
sequenceIdstring
sequenceNamestring
statusesstring[]

Enrollment statuses included in this response.

Example response

{
  "success": true,
  "sequenceId": "seq_abc123",
  "sequenceName": "Onboarding",
  "statuses": [
    "active",
    "waiting"
  ],
  "enrollments": [
    {
      "enrollmentId": "tok_abc123",
      "sequenceId": "seq_abc123",
      "subscriberId": "sub_abc123",
      "email": "customer@example.com",
      "firstName": "Wanda",
      "lastName": "Waiter",
      "subscriberStatus": "active",
      "status": "waiting",
      "currentNodeId": "node_wave_1",
      "currentNodeType": "logic_delay",
      "currentNodeLabel": "Start at Wave 1",
      "enrollmentKey": "__default__",
      "enrollmentStartedAt": "2026-01-01T00:00:00.000Z",
      "waitUntil": "2026-01-04T00:00:00.000Z",
      "lastUpdatedAt": "2026-01-01T00:00:00.000Z",
      "failedReason": "Automation seq_abc123 not found"
    }
  ],
  "pagination": {
    "limit": 50,
    "count": 1,
    "total": 1
  }
}