List enrollments

curl --request GET \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments \
  --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', 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",
  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"

	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")

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

{
  "data": [
    {
      "_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"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "pages": 123
  }
}

{
  "message": [
    "limit must not be greater than 100"
  ],
  "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": "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"
}

Enrollments

List enrollments

Lists the team’s enrollments, one row per contact per sequence, newest first: where each contact is in the cadence, who owns them, and how they have engaged. It reads every enrollment on the team, whoever owns it, and needs no user_id.

A contact holds at most one live enrollment (pending, active or paused) in a sequence. Once that one has ended (finished, bounced, opted_out or failed) the contact can be enrolled in the same sequence again, so one contact can appear more than once for a sequence.

Filter on pending_reason=approval to build an approval queue, then clear it with Approve held enrollments in bulk or Reject held enrollments in bulk. People who were refused never get an enrollment; they are on the sequence’s refusals list.

Paged with page and limit (default 10, at most 100). Counts toward the Sequencer reads rate limit.

GET

sequencer

enrollments

List enrollments

curl --request GET \
  --url https://client-api.salesfinity.co/v2/sequencer/enrollments \
  --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', 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",
  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"

	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")

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

{
  "data": [
    {
      "_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"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "pages": 123
  }
}

{
  "message": [
    "limit must not be greater than 100"
  ],
  "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": "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"
}

Lists the team’s enrollments, newest first. An enrollment is one contact’s place in one sequence, so a contact in three sequences has three. The list covers the whole team, whoever owns each enrollment, and needs no user_id.

Enrollment states

State	Meaning	Live
`pending`	Enrolled but not started. Either a rule is holding it for approval (`pending_reason` is `approval`), or its sequence is off and it starts when the sequence is turned on.	Yes
`active`	Working through the steps.	Yes
`paused`	Stopped until it is resumed: by hand, at its `resume_at`, or, if turning the sequence off paused it, when the sequence is turned back on.	Yes
`finished`	Ended: it ran out of steps, was un-enrolled or rejected, or a reply or a rule finished it.	No
`bounced`	An email to the contact bounced. Nothing more is sent.	No
`opted_out`	The contact opted out. Nothing more is sent.	No
`failed`	The engine could not continue. `error_reason` says why; retry it after fixing the cause.	No

A contact can hold one live enrollment per sequence. Once it has ended, the contact can be enrolled in that sequence again, so you can see several enrollments for the same contact and sequence. The newest comes first.

Common queries

To get	Query string
The approval queue	`?pending_reason=approval&limit=100`
Everyone in one sequence	`?sequence=SEQUENCE_ID`
One contact across every sequence	`?contact=CONTACT_ID`
One rep’s running enrollments in a sequence	`?sequence=SEQUENCE_ID&user=USER_ID&state=active`

curl 'https://client-api.salesfinity.co/v2/sequencer/enrollments?pending_reason=approval&limit=100' \
  -H 'x-api-key: YOUR_API_KEY'

Pages hold 10 enrollments unless you set limit (up to 100). pagination.pages says how many pages there are; request page=2, page=3 and so on until you reach it. People a check refused were never enrolled, so they are not in this list. Find them, with the reason, on the sequence’s refusals list.

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.

Query Parameters

limit

number

Results per page. Default 10. Above 100 is treated as 100.

Required range: 1 <= x <= 100

page

number

default:1

Page number, 1-based. At most 10,000.

Required range: 1 <= x <= 10000

sequence

string

Only enrollments in this sequence.

contact

string

Only enrollments for this contact.

state

enum<string>

pending: enrolled but not started — held for approval (pending_reason is approval) or waiting for its sequence to be turned on. active: working through the steps. paused: stopped until it is resumed. finished, bounced, opted_out and failed are terminal; pending, active and paused hold the contact's one live slot in the sequence.

Available options:

pending,

active,

paused,

finished,

bounced,

opted_out,

failed

pending_reason

enum<string>

approval returns only the enrollments a rule of engagement is holding for a manager's decision.

Available options:

approval

user

string

Only enrollments owned by this team member, whose queue gets their tasks.

Response

Success.

A page of results.

data

object[]

required

Show child attributes

pagination

object

required

Pagination for the paged lists under /v2/sequencer. Every paged list uses this one shape; a few short lists (a sequence's steps, the team's policies, a task's events and enrollment runs) return a plain array instead.

Show child attributes

Get started

MCP server

MCP reference

MCP use cases

Dialer API

Calls and analytics API

Enrichment API

Sequencer API

List enrollments

Enrollment states

Common queries

Authorizations

Query Parameters

Response

​Enrollment states

​Common queries

Authorizations

Query Parameters

Response

Enrollment states

Common queries