Skip to main content
GET
What turning a flow on will do

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Path Parameters

flow_id
string
required

Response

200 - application/json

Successful Response

can_enable
boolean
required
first_run
string
required
last_full_test
Last Full Test · object | null
required
matching_records
integer
required

Records the audience matches now; -1 when not countable ahead

per_run
string[]
required
preview_token
string
required
problems
string[]
required
trigger
string
required
examples
string[]

Up to 5 of the records that match now, by name

has_run_before
boolean
default:false

It has run since its last reset: turning it on needs a choice, mode continue (keep the history) or fresh

is_on
boolean
default:false

Already on: enabling again only restarts its run history (mode fresh)

last_run_at
string | null

When it last ran

runs_so_far
integer
default:0

Runs since its last reset

warnings
string[]

Worth a look before turning it on, but not refused: e.g. a template subject whose merge tags a send leaves as typed