Retrieve a sequence enrollment

client.sequence.retrieveEnrollment(, , ?): SequenceRetrieveEnrollmentResponse { id, cancelledAt, completedAt, 10 more }

GET/v1/sequences/{id}/enrollments/{enrollmentId}

Retrieves a single enrollment by its ID: the contact’s position in the cadence and its latest activity. Test-run enrollments are not returned.

Required scope: sequences:read

Rate limit category: Read

ParametersExpand Collapse

enrollmentID: string

Unique identifier of the enrollment to retrieve.

params: SequenceRetrieveEnrollmentParams { id }

id: string

Unique identifier of the sequence.

ReturnsExpand Collapse

SequenceRetrieveEnrollmentResponse { id, cancelledAt, completedAt, 10 more }

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"

Retrieve a sequence enrollment

import Lightfield from 'lightfield';

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

const sequenceRetrieveEnrollmentResponse = await client.sequence.retrieveEnrollment(
  'enrollmentId',
  { id: 'id' },
);

console.log(sequenceRetrieveEnrollmentResponse.id);

{
  "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"
}

Returns Examples

{
  "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"
}