List enrollments
curl --request GET \
--url https://client-api.salesfinity.co/v2/sequencer/enrollments \
--header 'x-api-key: <api-key>'import requests
url = "https://client-api.salesfinity.co/v2/sequencer/enrollments"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v2/sequencer/enrollments")
.header("x-api-key", "<api-key>")
.asString();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"
}
],
"pagination": {
"total": 123,
"page": 123,
"limit": 123,
"pages": 123
}
}{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}Sequencer Enrollments
List enrollments
One row per contact per sequence: where they are in the cadence, who owns them, and how they have engaged. A contact can hold only one live enrollment in a given sequence, but may be re-enrolled once an earlier one has finished.
GET
/
v2
/
sequencer
/
enrollments
List enrollments
curl --request GET \
--url https://client-api.salesfinity.co/v2/sequencer/enrollments \
--header 'x-api-key: <api-key>'import requests
url = "https://client-api.salesfinity.co/v2/sequencer/enrollments"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)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))
}HttpResponse<String> response = Unirest.get("https://client-api.salesfinity.co/v2/sequencer/enrollments")
.header("x-api-key", "<api-key>")
.asString();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"
}
],
"pagination": {
"total": 123,
"page": 123,
"limit": 123,
"pages": 123
}
}{
"message": [
"limit must not be greater than 100"
],
"error": "Bad Request",
"statusCode": 400
}{
"message": "Forbidden resource",
"error": "Forbidden",
"statusCode": 403
}{
"message": "Too many requests",
"error": "Too Many Requests",
"statusCode": 429
}{
"message": "Internal server error",
"error": "Internal Server Error",
"statusCode": 500
}One row per contact per sequence: where they are in the cadence, who owns them, and how they have engaged. A contact can hold only one live enrollment in a given sequence, but may be re-enrolled once an earlier one has finished.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings -> Connections & API. A missing or invalid key returns HTTP 403.
Query Parameters
Results per page.
Required range:
x <= 100Page number, 1-based.
Only enrollments in this sequence.
Only enrollments for this contact.
finished, bounced, opted_out and failed are terminal; the rest still hold the contact’s one live slot in the sequence.
Available options:
pending, active, paused, finished, bounced, opted_out, failed Only enrollments a rule is holding for approval.
Available options:
approval Only enrollments owned by this team member.