Skip to main content
GET
Get a step
Returns one step of a sequence, with its timing, type, templates and per-step engagement counters. The step is looked up inside the sequence in the path, so a step id from another sequence returns 404.

Example

The per-step counters (open_count, reply_count and the rest) count events, not people, and are rebuilt every 15 minutes. On an email step with several templates, compare the variants with each template’s own counters on Get an email template.

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

sequence_id
string
required

24-character sequence id.

step_id
string
required

24-character step id.

Response

The step.

One step of a cadence.

_id
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

sequence
string

The sequence the step belongs to (24-character id).

Example:

"507f1f77bcf86cd799439011"

team
string

The team that owns the step (24-character id).

order
integer

1-based position in the cadence. Steps run in this order; change it with PUT /v2/sequencer/sequences/{sequence_id}/steps/reorder.

step_type
enum<string>

auto_email sends an email on its own. manual_email creates a task with the email drafted from a template, for the rep to edit and send. call creates a call task. task creates a to-do. Tasks go to the rep who owns the enrollment.

Available options:
auto_email,
manual_email,
call,
task
interval_seconds
integer | null

On an interval sequence: seconds to wait after the previous step finished (an email sent, or a task completed or skipped) before this step comes due. For the first step, the wait after enrollment. Absent on a date sequence.

date
string<date-time> | null

On a date sequence: when the step comes due. Absent on an interval sequence.

display_name
string | null

Step label. Becomes the title of the task the step creates.

new_thread
boolean

Email steps: true starts a new email thread with this step's template subject; false replies in the previous email's thread, so the template's subject is not sent. The first email step always starts a thread.

task_note
string | null

Note copied onto the task the step creates.

task_priority
enum<string>

Priority copied onto the task the step creates. Defaults to medium.

Available options:
high,
medium,
low
task_autoskip_delay
integer | null

Seconds after the task is created (when the step comes due) at which a still-open task expires and the enrollment moves on to the next step. Absent means tasks wait indefinitely.

templates
object[]

Email steps: the templates to pick from, by weight. Empty for call and task steps.

call_purpose
object

Call steps only: the call purpose set on the step. Absent when none is set.

deliver_count
integer

Number of deliveries from this step, counted as events. Rebuilt every 15 minutes.

open_count
integer

Number of opens from this step, counted as events. Rebuilt every 15 minutes.

click_count
integer

Number of link clicks from this step, counted as events. Rebuilt every 15 minutes.

reply_count
integer

Number of replies from this step, counted as events. Rebuilt every 15 minutes.

bounce_count
integer

Number of bounces from this step, counted as events. Rebuilt every 15 minutes.

opt_out_count
integer

Number of opt-outs from this step, counted as events. Rebuilt every 15 minutes.

failure_count
integer

Number of failed sends from this step, counted as events. Rebuilt every 15 minutes.

schedule_count
integer

Times this step ran and produced work: emails sent plus tasks created. Rebuilt every 15 minutes.

created_at
string<date-time>

When the step was created.

updated_at
string<date-time>

When it last changed.