Get a sequence
Returns one sequence by id: its settings, step and engagement counters, and can_manage. Archived sequences are returned too, with archived_at set. A sequence on another team returns 404.
Engagement counters count events, not people, and are rebuilt every 15 minutes. For live per-person numbers use GET /v2/sequencer/sequences/{id}/analytics/people. Reads act as the team owner, so can_manage is always true. Counts toward the Sequencer reads rate limit.
can_manage. A
sequence on another team returns 404, the same as one that does not exist.
Example
Things to know
- Archived sequences are returned too, with
archived_atset. They are left out of List sequences, cannot be enabled, and refuse new enrollments. Archiving happens in the dashboard; the API has no archive endpoint. - Engagement counters (
open_count,reply_countand the rest) count events, not people, and are rebuilt every 15 minutes. For live, per-person numbers use List the people behind an engagement metric; for live enrollment counts use Get sequence analytics. - Optional settings that were never set, such as
throttle_capacityorschedule, are absent from the response rather thannull. - Reads act as the team owner, so
can_manageis alwaystruehere.
Authorizations
Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.
Path Parameters
24-character sequence id.
Response
The sequence.
A Sequencer sequence (a cadence). can_manage is returned by list and get only; step_type_counts and enrollment_counts by list only.
24-character hexadecimal id.
"507f1f77bcf86cd799439011"
The team that owns the sequence (24-character id).
Sequence name.
Free-text labels for filtering.
Whether the sequence is running. New and duplicated sequences start false.
interval: each step waits interval_seconds after the previous one. date: each step comes due on its own date.
interval, date Author's team member id. Only the author, the team owner or an admin can change the sequence. On GET /v2/sequencer/sequences this field arrives expanded, as an object with _id, first_name, last_name and email, not as a string.
Rules-of-engagement policy id, or null (or absent) when the sequence uses the team default policy.
Whether the sequence is transactional: enrollment skips the suppression list, and sends skip only unsubscribed and manual suppression entries.
Most live (pending, active or paused) enrollments per owner. Absent when there is no cap.
Most new enrollments per owner per day. Absent when there is no cap.
When true, adding people is refused while the sequence keeps running for those already in it.
Whether emails carry an open-tracking pixel.
Whether links in emails are rewritten to track clicks.
Number of steps. Updated whenever a step is added, changed or deleted.
Sum of the steps' interval_seconds, rounded up to whole days. Always 0 on a date sequence.
Distinct people reached: sent or delivered an email, or a completed call or task. Rebuilt every 15 minutes.
Distinct people who replied. Rebuilt every 15 minutes.
Number of opens, counted as events, not people. Rebuilt every 15 minutes.
Number of link clicks, counted as events, not people. Rebuilt every 15 minutes.
Number of replies, counted as events, not people. Rebuilt every 15 minutes.
Number of bounces, counted as events, not people. Rebuilt every 15 minutes.
Number of opt-outs, counted as events, not people. Rebuilt every 15 minutes.
Number of deliveries, counted as events, not people. Rebuilt every 15 minutes.
When the sequence was last enabled. Absent if it never has been.
When the sequence was archived in the dashboard, or null. Archived sequences are left out of the list and cannot be enabled or enrolled into; the API has no archive endpoint.
What a reply that reads as interested, a meeting request, or unclear does to the enrollment.
finish, continue, pause Seconds an enrollment pauses for when primary_reply_action is pause. Absent means the pause lasts until someone resumes it.
The sequence's own sending window. Absent when the sequence uses the team default schedule.
Mailbox ids the sequence sends from. Empty means the author's assigned mailboxes, or the team's shared ones when the author has none.
Number of failed sends, counted as events. Rebuilt every 15 minutes.
Number of times a step ran and produced work: emails sent plus tasks created. Rebuilt every 15 minutes.
num_replied_prospects as a percentage of num_contacted_prospects, 0 to 100, rounded. 0 while nobody has been contacted.
Share of steps that are auto_email, 0 to 100, rounded.
When anything last happened in the sequence (an email, a task, a reply). Null for a sequence that has done nothing.
List only. How many steps of each type the sequence has. Every type is always present.
List only. Live count of the sequence's enrollments in each state, plus total. Every state is always present.
Whether the member the request acted as may change this sequence. API reads act as the team owner, so this is true on every API read; it does not tell you whether a given user_id may edit. Returned by list and get only.
When the sequence was created.
When it last changed.