List enrollment events

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

import requests

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

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/{id}/events', 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}/events",
  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}/events"

	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}/events")

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",
      "type": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "sequence": "<string>",
      "sequence_step": "<string>",
      "contact": "<string>",
      "payload": {},
      "team": "<string>",
      "sequence_state": "<string>",
      "task": "<string>",
      "user": {
        "_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      },
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "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": "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"
}

Enrollments

List enrollment events

Returns one enrollment’s timeline, newest first: the enrollment, its tasks, sends, opens, clicks, replies, rule decisions, approvals, reassignments, pauses and the finish. It is the audit trail for why a contact is where they are.

Paged with page and limit (default 50, at most 100). Filter to one kind of event with type. payload holds the detail for each type: for example approval_requested carries the rule’s rule_id, rule_name and reason, and policy_applied lists the rule decisions. The timeline can also hold rescheduled events, written when someone moves the next touch; they are listed but cannot be used as a type filter.

For a one-off task, which has no enrollment, use List task events. Counts toward the Sequencer reads rate limit.

GET

sequencer

enrollments

{id}

events

List enrollment events

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

import requests

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

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/{id}/events', 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}/events",
  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}/events"

	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}/events")

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",
      "type": "<string>",
      "occurred_at": "2023-11-07T05:31:56Z",
      "sequence": "<string>",
      "sequence_step": "<string>",
      "contact": "<string>",
      "payload": {},
      "team": "<string>",
      "sequence_state": "<string>",
      "task": "<string>",
      "user": {
        "_id": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>"
      },
      "external_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "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": "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’s timeline, newest first. Every step, send, reply, rule decision and change of hands is recorded here, so it answers “why is this contact where they are?” without guessing. Rows are never edited; a correction is a new row. Pages hold 50 events unless you set limit (up to 100). Pass type to see one kind of event only.

Event types

Type	Written when	Detail in `payload`
`enrolled`	The contact was enrolled.	`enrolled_by`, and `live`: false if it started `pending`
`task_created`	A step came due and created a task.
`task_completed`, `task_skipped`	A task was completed or skipped.
`task_reassigned`	A task moved to another rep.	`from_user`, `to_user`
`step_skipped`	A step was passed over because the contact cannot be reached on its channel. The cadence carries on.	`reason` (`no_email` or `no_phone`), `step_order`
`call_completed`	A call for the enrollment was completed.
`email_sent`, `delivered`, `opened`, `clicked`	An email was sent, delivered, opened or clicked.
`replied`	The contact replied.
`reply_categorized`	A reply’s category changed after it was recorded.	`category`
`bounced`, `opted_out`	An email bounced, or the contact opted out.
`policy_applied`	A rule of engagement decided something other than allow.	`point` (`enrollment` or `step`), `verdict`, `decisions`
`policy_overridden`	Someone added the contact although a rule blocked them.	`overridden_by`, `rule`
`approval_requested`	A rule held the enrollment for approval.	`rule_id`, `rule_name`, `reason`
`approval_granted`	Someone approved it.	`approved_by`, `note`, `live`
`approval_rejected`	Someone rejected it.	`rejected_by`, `note`
`enrollment_reassigned`	The enrollment moved to another owner.	`from_user`, `to_user`, `tasks_moved`, `note`, `by`
`outcome`	Something the outcome rules react to happened.	`outcome`, `source`, `actions`
`follow_up_scheduled`	A follow-up enrollment was scheduled.	`sequence`, `delay_days`, `rule_id`, `rule_name`, `run_at`
`follow_up_skipped`	A follow-up was due but refused.
`account_action`	An account-level action finished or paused this enrollment.	`action`, `scope`, `triggered_by`
`paused`, `resumed`	The enrollment was paused or resumed.	`paused`: `reason`
`rescheduled`	Someone moved the next touch. Listed, but not accepted by the `type` filter.	`from`, `to`, `tasks_moved`, `by`
`finished`, `failed`	The enrollment finished or failed.	After a rejection, `finished` carries `reason`: `approval_rejected`.

occurred_at is when the event happened, and the list is sorted on it. payload is absent on events that carry no detail.

Example

Find out why a contact never started:

curl 'https://client-api.salesfinity.co/v2/sequencer/enrollments/ENROLLMENT_ID/events?type=approval_requested' \
  -H 'x-api-key: YOUR_API_KEY'

A one-off task has no enrollment, so its history is not here. Read it with List task events.

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.

Query Parameters

limit

number

Results per page. Default 50. 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

type

enum<string>

Only events of this type. rescheduled events also appear on timelines but are not accepted here.

Available options:

enrolled,

task_created,

email_sent,

delivered,

opened,

clicked,

replied,

bounced,

opted_out,

call_completed,

task_completed,

task_skipped,

step_skipped,

reply_categorized,

policy_applied,

policy_overridden,

approval_requested,

approval_granted,

approval_rejected,

task_reassigned,

enrollment_reassigned,

outcome,

follow_up_scheduled,

follow_up_skipped,

account_action,

paused,

resumed,

finished,

failed

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 enrollment events

Event types

Example

Authorizations

Path Parameters

Query Parameters

Response

​Event types

​Example

Authorizations

Path Parameters

Query Parameters

Response

Event types

Example