Skip to main content
GET
List Outreach Workflow Stages

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

outreach_workflow_id
string
required

Response

Successful response

action
enum<string>
required
Available options:
email,
call
Maximum string length: 5
event
string
required
name
string
required

The name of the stage.

object
string
required
time_trigger
string
required
workflow_id
string
required
Maximum string length: 32
id
string
Maximum string length: 32
auto_send
boolean

Whether to automatically send emails created by this stage. When false, the emails will be created and left in a draft state for you to send. Defaults to true.

cc
string[]

List of email addresses to CC on the emails created by this stage.

cc_secondary_contacts
boolean

Whether to CC all external contacts on the emails created by this stage.

created_at
string<date-time>
email_template
object
external_roles_to_cc
string[]

List of external roles to CC on the emails created by this stage.

fallback_email_template
object
internal_roles_to_cc
string[]

List of internal roles to CC on the emails created by this stage.

is_always_run_enabled
boolean

Whether to ignore the workflow's active days.

modified_at
string<date-time> | null
num_days
integer | null
outreach_window_end
string | null

Override end time for outreach window (optional stage-level override)

outreach_window_start
string | null

Override start time for outreach window (optional stage-level override)

recurrence_end_offset_days
integer | null

If set, stops recurring after N days past the event date; null where time_trigger = 'before' = until event date, null where time_trigger = 'after' = forever.

recurrence_interval_days
integer | null

If set (>0), after the initial trigger this stage will re-fire every X days. Null = no recurrence.