GET
List marketing flow runs

Authorizations

Authorization
string
header
required

A secret API key. Publishable keys cannot reach this API. A key may carry an expiry, and an expired key is refused exactly like an unknown one, with a 401 that names no reason; check the key's expires_at in the dashboard rather than inferring it from a response. When a merchant rolls a key's secret they choose a grace window of up to 3 days, and for its duration BOTH the new secret and the one it replaced authenticate, so an integration moves over on its own deploy schedule instead of at the instant the button is pressed. Move before the window closes: after it, the old secret is refused. Nothing else about this contract moves with a roll. The key keeps its id and its scopes, so the only thing an integration updates is the credential itself.

Query Parameters

flow_id
string

Narrow to one program: who is in it and where they are. An id that names no flow in this store returns an empty page rather than a 404, because this is one optional filter among three and a caller reconciling by contact_id has no flow to verify.

contact_id
string

Narrow to one person: which programs they are in across the whole store. This is the reconciliation a customer-record integration performs, and it is why runs are a top-level collection rather than nested under a flow.

status
enum<string>

Narrow to one run state. There is no claimed value here even though the engine has one internally: a leased run publishes as active, so accepting claimed would return rows whose published status is a different word from the one asked for. An unrecognised value is a 400.

Available options:
active,
waiting,
completed,
exited,
errored,
cancelled
limit
integer
default:20

Rows per page. Out of range is a 400 rather than a silent clamp, so a client asking for more than 100 learns it did not get it.

Required range: 1 <= x <= 100
after
string

The next_cursor from the previous page. Opaque: decode nothing from it and construct nothing by hand, since its encoding is not part of this contract. Omit it to read the first page.

Response

Success

data
object[]
page
object