Skip to main content
GET
Get an enrollment
One contact’s position in one sequence: state, current step, when the next step is due, owner, and engagement counters.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.

Path Parameters

id
string
required

24-character enrollment id.

Response

Success.

One contact's position in one sequence.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

sequence
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

contact
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

user
string

Owning team member. Their queue gets the tasks.

state
enum<string>
Available options:
pending,
active,
paused,
finished,
bounced,
opted_out,
failed
current_step
string | null
current_step_order
integer | null
next_step_due_at
string<date-time> | null

Null while the enrollment is blocked on a task, paused, or terminal.

pending_reason
enum<string> | null
Available options:
approval,
null
pause_reason
string | null
resume_at
string<date-time> | null
last_reply_category
string | null
replied_at
string<date-time> | null
finished_at
string<date-time> | null
open_count
integer
reply_count
integer
created_at
string<date-time>

When the contact was enrolled.