List sequence enrollments

client.sequence.listEnrollments(, ?, ?): SequenceListEnrollmentsResponse { data, object, totalCount }

GET/v1/sequences/{id}/enrollments

Returns a paginated list of a sequence’s enrollments, including completed and cancelled ones. Results are sorted by when the contact was enrolled (enrolledAt), newest first. Test-run enrollments are not included. Use offset and limit to paginate through results, and bracketed filters to narrow the list. See List endpoints for more information about pagination.

Supported filters: status[equal] (ACTIVE, AWAITING_REVIEW, NEEDS_ATTENTION, REPLIED, COMPLETED, PAUSED, CANCELLED, FAILED), contactId[equal], currentStepId[equal], and enrolledAt, lastActivityAt or repliedAt with [greaterThanOrEqual] or [lessThanOrEqual] (ISO 8601 timestamps with a timezone). Filters are combined with AND.

Required scope: sequences:read

Rate limit category: Search

ParametersExpand Collapse

id: string

Unique identifier of the sequence.

query: SequenceListEnrollmentsParams { limit, offset }

limit?: number

Maximum number of records to return. Defaults to 25, maximum 25.

minimum1

maximum9007199254740991

offset?: number

Number of records to skip for pagination. Defaults to 0.

minimum0

maximum9007199254740991

ReturnsExpand Collapse

SequenceListEnrollmentsResponse { data, object, totalCount }

data: Array<Data>

id: string

Unique identifier of the enrollment.

cancelledAt: string | null

When the enrollment was cancelled, or null if it was not.

completedAt: string | null

When the enrollment completed, or null if it has not.

contactId: string

ID of the enrolled contact.

currentStepId: string | null

ID of the step the contact is on, matching definition.steps; null when the contact has no current step the API returns.

enrolledAt: string

When the contact was enrolled.

enrolledBy: string | null

Member ID of whoever enrolled the contact; null when they are no longer a member or the enrollment was automatic.

lastActivityAt: string | null

When lastActivityKind happened; null when there has been no activity.

lastActivityKind: "SENT" | "OPENED" | "REPLIED" | 4 more | null

The latest activity on the enrollment. A reply or bounce that ended the enrollment is reported over a later open.

One of the following:

"SENT"

"OPENED"

"REPLIED"

"BOUNCED"

"INVITED"

"CONNECTED"

"SEEN"

nextSendAt: string | null

Estimated time of the next send, from the cadence, send window, pacing and sender; queue order and random gaps can push it later. Null while a message awaits review or is sending, while paused, or when it cannot be estimated.

remainingSends: number | null

Email and LinkedIn steps not yet sent, connection requests included.

minimum-9007199254740991

maximum9007199254740991

repliedAt: string | null

When the contact first replied, on email or LinkedIn; null if they have not.

status: "ACTIVE" | "AWAITING_REVIEW" | "NEEDS_ATTENTION" | 5 more | null

ACTIVE is progressing; AWAITING_REVIEW has a message waiting for approval; NEEDS_ATTENTION is held by a failed step, a held draft or an unavailable sender; PAUSED is stopped because the sequence is deactivated or it was paused in Lightfield. REPLIED, COMPLETED, CANCELLED and FAILED are final.

One of the following:

"ACTIVE"

"AWAITING_REVIEW"

"NEEDS_ATTENTION"

"REPLIED"

"COMPLETED"

"PAUSED"

"CANCELLED"

"FAILED"

object: "list"

totalCount: number

minimum-9007199254740991

maximum9007199254740991

List sequence enrollments

import Lightfield from 'lightfield';

const client = new Lightfield({
  apiKey: 'My API Key',
});

const sequenceListEnrollmentsResponse = await client.sequence.listEnrollments('id');

console.log(sequenceListEnrollmentsResponse.data);

{
  "data": [
    {
      "id": "id",
      "cancelledAt": "cancelledAt",
      "completedAt": "completedAt",
      "contactId": "contactId",
      "currentStepId": "currentStepId",
      "enrolledAt": "enrolledAt",
      "enrolledBy": "enrolledBy",
      "lastActivityAt": "lastActivityAt",
      "lastActivityKind": "SENT",
      "nextSendAt": "nextSendAt",
      "remainingSends": -9007199254740991,
      "repliedAt": "repliedAt",
      "status": "ACTIVE"
    }
  ],
  "object": "list",
  "totalCount": -9007199254740991
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "cancelledAt": "cancelledAt",
      "completedAt": "completedAt",
      "contactId": "contactId",
      "currentStepId": "currentStepId",
      "enrolledAt": "enrolledAt",
      "enrolledBy": "enrolledBy",
      "lastActivityAt": "lastActivityAt",
      "lastActivityKind": "SENT",
      "nextSendAt": "nextSendAt",
      "remainingSends": -9007199254740991,
      "repliedAt": "repliedAt",
      "status": "ACTIVE"
    }
  ],
  "object": "list",
  "totalCount": -9007199254740991
}