Sign in
latestOpenAPI 3.1.0raw.githubusercontent.com2026-08-192731541009.1 KB

ba3a29c6eb33

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.

stopConditionMatchboolean

Annotate each returned active or waiting enrollment with whether the sequence stop condition already matches for that contact right now. Stop conditions are re-evaluated when an enrollment next runs a step, not when their event arrives, so a stopped contact keeps reporting waiting until its delay expires. Use this to confirm a stop event registered without waiting the delay out. Caps the page at 100 regardless of limit.

limitinteger

Enrollments per page. Values above 500 are capped, and above 100 when stopConditionMatch is true.

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.

stopConditionMatchEvaluatedCountinteger

How many enrollments in this page were actually evaluated for a current stop-condition match. 0 when stopConditionMatch was not requested, the sequence has no stop condition, or no returned enrollment was still active or waiting.

Example response

{
  "success": true,
  "sequenceId": "seq_abc123",
  "sequenceName": "Onboarding",
  "statuses": [
    "active",
    "waiting"
  ],
  "stopCondition": {
    "value": "saas.purchase",
    "matchConfig": {
      "propertyFilters": [
        {
          "path": "quota_used"
        }
      ]
    }
  },
  "stopConditionMatchEvaluatedCount": 1,
  "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",
      "movedFromNodeId": "node_delay_2",
      "movedAt": "2026-03-01T09:00:00.000Z",
      "moveReason": "Wave 3",
      "stopConditionMatches": true,
      "stopConditionMatchReason": "Subscriber received stop event: onboarding.completed"
    }
  ],
  "pagination": {
    "limit": 50,
    "count": 1,
    "total": 1
  }
}