Get an enrollment

curl --request GET \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "_id": "507f1f77bcf86cd799439011",
  "sequence": "507f1f77bcf86cd799439011",
  "contact": "507f1f77bcf86cd799439011",
  "user": "<string>",
  "state": "pending",
  "current_step": "<string>",
  "current_step_order": 123,
  "next_step_due_at": "2023-11-07T05:31:56Z",
  "pending_reason": "approval",
  "pause_reason": "<string>",
  "resume_at": "2023-11-07T05:31:56Z",
  "last_reply_category": "<string>",
  "replied_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "open_count": 123,
  "reply_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "team": "<string>",
  "creator": "<string>",
  "state_changed_at": "2023-11-07T05:31:56Z",
  "active_at": "2023-11-07T05:31:56Z",
  "approval": {
    "rule_id": "<string>",
    "rule_name": "<string>",
    "reason": "<string>",
    "requested_at": "2023-11-07T05:31:56Z",
    "decided_at": "2023-11-07T05:31:56Z",
    "decided_by": "<string>",
    "decision": "approved",
    "note": "<string>"
  },
  "error_reason": "<string>",
  "enrollment_source": {},
  "last_reply_at": "2023-11-07T05:31:56Z",
  "click_count": 123,
  "deliver_count": 123,
  "bounce_count": 123,
  "opt_out_count": 123,
  "failure_count": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "Invalid ObjectId",
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequence state not found",
  "error": "Not Found",
  "statusCode": 404,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Rate limit of 300 requests per minute exceeded. Retry in 12s.",
  "error": "Too Many Requests",
  "statusCode": 429,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service unreachable",
  "error": "Bad Gateway",
  "statusCode": 502,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service timed out",
  "error": "Gateway Timeout",
  "statusCode": 504,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

GET

sequencer

enrollments

{id}

Get an enrollment

curl --request GET \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://client-api.salesfinity.co/v2/sequencer/enrollments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "_id": "507f1f77bcf86cd799439011",
  "sequence": "507f1f77bcf86cd799439011",
  "contact": "507f1f77bcf86cd799439011",
  "user": "<string>",
  "state": "pending",
  "current_step": "<string>",
  "current_step_order": 123,
  "next_step_due_at": "2023-11-07T05:31:56Z",
  "pending_reason": "approval",
  "pause_reason": "<string>",
  "resume_at": "2023-11-07T05:31:56Z",
  "last_reply_category": "<string>",
  "replied_at": "2023-11-07T05:31:56Z",
  "finished_at": "2023-11-07T05:31:56Z",
  "open_count": 123,
  "reply_count": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "team": "<string>",
  "creator": "<string>",
  "state_changed_at": "2023-11-07T05:31:56Z",
  "active_at": "2023-11-07T05:31:56Z",
  "approval": {
    "rule_id": "<string>",
    "rule_name": "<string>",
    "reason": "<string>",
    "requested_at": "2023-11-07T05:31:56Z",
    "decided_at": "2023-11-07T05:31:56Z",
    "decided_by": "<string>",
    "decision": "approved",
    "note": "<string>"
  },
  "error_reason": "<string>",
  "enrollment_source": {},
  "last_reply_at": "2023-11-07T05:31:56Z",
  "click_count": 123,
  "deliver_count": 123,
  "bounce_count": 123,
  "opt_out_count": 123,
  "failure_count": 123,
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "message": "Invalid ObjectId",
  "error": "Bad Request",
  "statusCode": 400,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequence state not found",
  "error": "Not Found",
  "statusCode": 404,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Rate limit of 300 requests per minute exceeded. Retry in 12s.",
  "error": "Too Many Requests",
  "statusCode": 429,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Internal server error",
  "error": "Internal Server Error",
  "statusCode": 500,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service unreachable",
  "error": "Bad Gateway",
  "statusCode": 502,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

{
  "message": "Sequencer service timed out",
  "error": "Gateway Timeout",
  "statusCode": 504,
  "request_id": "0f6d3c52-9f3e-4c1a-a4b8-2b1f7e5d9c10"
}

Returns one enrollment: where one contact is in one sequence, and why. Any enrollment on the team can be read, and no user_id is needed.

Reading an enrollment

To find out	Read
Whether it is running	`state`. List enrollments explains each state.
What runs next, and when	`current_step`, `current_step_order` and `next_step_due_at`
Why `next_step_due_at` is null	The enrollment is `pending`, waiting on an open task, `paused`, or has ended.
Why it is held	`pending_reason` is `approval`, and `approval.rule_name` and `approval.reason` name the rule.
Who approved or rejected it	`approval.decision`, `approval.decided_by`, `approval.decided_at` and `approval.note`
Why it is paused	`pause_reason`, and `resume_at` if it resumes itself
Why it failed	`error_reason`
Who owns it, and who enrolled it	`user` owns it and gets its tasks; `creator` enrolled it.
How the contact has engaged	`open_count`, `click_count`, `reply_count`, `last_reply_category` and `last_reply_at`

For everything that has happened to the enrollment, in order, read its timeline with List enrollment events.

Acting on it

To	Call
Hold it, with an optional date to resume	Pause an enrollment
Pick it back up	Resume an enrollment
Take the contact out of the sequence	Un-enroll a contact
Hand it to another rep	Reassign an enrollment
Decide on a held enrollment	Approve or reject it
Restart a failed one	Retry a failed enrollment

Authorizations

x-api-key

string

header

required

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

Path Parameters

string

required

24-character enrollment id.

Response

Success.

One contact's position in one sequence. A response can also carry internal bookkeeping fields not listed here; do not rely on them.

_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>

pending: enrolled but not started, either held for approval or waiting for the sequence to be turned on. active: working through the steps. paused: stopped until resumed. finished, bounced, opted_out and failed are terminal.

Available options:

pending,

active,

paused,

finished,

bounced,

opted_out,

failed

current_step

string | null

Id of the step the enrollment is on: the next step to run, or the step whose task is open.

current_step_order

integer | null

The order of current_step in the sequence.

next_step_due_at

string<date-time> | null

When current_step is due to run. Null while the enrollment is pending, waiting on an open task, paused, or ended.

pending_reason

enum<string> | null

approval while a rule of engagement is holding the enrollment for a manager. Absent on a pending enrollment that is only waiting for its sequence to be turned on.

Available options:

approval,

null

pause_reason

string | null

Why it is paused: the pause_reason sent to Pause an enrollment, or one Salesfinity set, such as sequence_disabled, replied, out_of_office, policy, outcome_rule, account_action, schedule_closed or transient_error.

resume_at

string<date-time> | null

When a paused enrollment resumes itself. Absent when it waits for someone to resume it.

last_reply_category

string | null

How the most recent reply was classified: interested, meeting_request, not_interested, out_of_office, wrong_person, unsubscribe_request, auto_reply or unknown.

replied_at

string<date-time> | null

finished_at

string<date-time> | null

When the enrollment was finished.

open_count

integer

Opens recorded on this enrollment's emails.

reply_count

integer

Replies recorded from this contact.

created_at

string<date-time>

When the contact was enrolled.

team

string

The team's id.

creator

string

The team member who enrolled the contact: the user_id of the call that created the enrollment. Can differ from the owner.

state_changed_at

string<date-time>

When state last changed.

active_at

string<date-time>

When the enrollment first became active. Absent until then.

approval

object | null

The approval hold, when a rule held this enrollment: which rule and why and, once decided, who decided, when, the decision and the note. Null if no rule ever held it.

Show child attributes

error_reason

string | null

Why the enrollment failed, when state is failed. Cleared by a retry.

enrollment_source

object | null

Set when Salesfinity created the enrollment itself, for example from a follow-up rule. Null when a person or an API call enrolled the contact.

last_reply_at

string<date-time>

When the most recent reply arrived.

click_count

integer

Link clicks recorded on this enrollment's emails.

deliver_count

integer

Emails confirmed delivered.

bounce_count

integer

Bounces recorded.

opt_out_count

integer

Opt-outs recorded.

failure_count

integer

Errors on the current step so far. Reset to 0 by a retry.

updated_at

string<date-time>

When the enrollment last changed.

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

Get an enrollment

Reading an enrollment

Acting on it

Authorizations

Path Parameters

Response

​Reading an enrollment

​Acting on it

Authorizations

Path Parameters

Response

Reading an enrollment

Acting on it