Skip to main content
GET
cURL

Overview

Retrieve one step of an enrollment by its ID. For email steps, email contains the current copy and its version_id. Read the step before updating its copy so your edit starts from the latest version. Get step IDs from List enrollment steps.

Authorizations

x-api-key
string
header
required

Path Parameters

id
string<uuid>
required

String UUID value.

Response

Response returned when fetching an enrollment step.

Response returned when fetching an enrollment step.

id
string<uuid>
required

String UUID value.

created_at
string<date-time>
required

String value representing an RFC 3339 datetime.

updated_at
string<date-time>
required

String value representing an RFC 3339 datetime.

enrollment_id
string<uuid>
required

String UUID value.

sequence_id
string<uuid>
required

String UUID value.

step_id
string<uuid>
required

ID of the sequence step this enrollment step was created from.

type
enum<string>
required

Type of a sequence enrollment step.

Available options:
AUTOMATIC_EMAIL,
MANUAL_EMAIL,
ACTION_ITEM,
ZAPIER,
PHONE_CALL,
MANUAL_LINKEDIN_PROFILE_VIEW,
MANUAL_LINKEDIN_CONNECTION,
MANUAL_LINKEDIN_MESSAGE
status
enum<string>
required

Status of an individual sequence enrollment step.

Available options:
NOT_STARTED,
SCHEDULED,
PENDING,
FINISHED,
CANCELED,
ERRORED,
UNREACHABLE
step_number
integer
required

Position of the step in the enrollment, starting at 1. Null until the step is expected to run or has finished.

Required range: x >= 1
is_blocked
boolean
required
is_bounced
boolean
required
is_canceled
boolean
required
is_opted_out
boolean
required
is_paused
boolean
required
is_replied
boolean
required
started_at
string<date-time> | null
required

String value representing an RFC 3339 datetime.

ended_at
string<date-time> | null
required

String value representing an RFC 3339 datetime.

email
object | null
required

Email copy for email steps. Null for other step types.