# List marketing flow runs

`GET /api/v1/marketing-flow-runs`

One row per contact per journey: who is in a program, which step they are on, and when they next move. ?flow_id= answers "who is in this program" and ?contact_id= answers "which programs is this person in". The second is the reconciliation an integration actually performs on a customer record, and no per-flow route could answer it without walking every flow in the store, which is why runs are a top-level collection here rather than nested under a flow. ?status= takes active, waiting, completed, exited, errored or cancelled. waiting is the durable-timer state a long program spends most of its life in; next_run_at says when it moves, and is a floor rather than an appointment. THE SCHEDULER'S OWN BOOKKEEPING IS NOT PUBLISHED. A run carries no lease, no attempt count and no trigger event id: the first two are this platform's crash-retry internals and the third belongs to the events family.

## 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` (active | waiting | completed | exited | errored | cancelled) — 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.
- `limit` (integer) — 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.
- `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.

## Responses

- `200` — Success
- `400` — The request was refused before any state changed. `code` is one of:

`invalid_body`, a write body this route will not take. `reason` partitions it
and `field` names the key when one key is at fault.
`invalid_query`, a query parameter, including limit and after.
`invalid_text`, a NUL byte or bytes that are not valid UTF-8 anywhere in the
path, the query or the body. Strip control characters before sending.
`idempotency_key_required`, a write sent without the Idempotency-Key header.
`invalid_request`, an Idempotency-Key longer than 255 bytes.

Routes add their own codes for rules only they know. Switch with a default arm.
- `401` — No credential, or one this API does not accept. `code` is always
`unauthorized`.

THE BODY IS DELIBERATELY UNINFORMATIVE. An expired key, a revoked key, a
publishable key, a key belonging to another merchant and a key that never
existed are all refused with the same bytes, so this response cannot be used to
probe which keys exist. Check the key's state in the dashboard rather than
inferring it here.

Send the key as `Authorization: Bearer <key>` or as `X-API-Key: <key>`. It is
never accepted in a query string.
- `403` — The key lacks the read_marketing_flows scope. `code` is `insufficient_scope` and the message names the scope to ask the merchant for.
- `429` — Too many requests. `code` is `rate_limited`.

Two limits apply independently: one on the credential and the route family,
one on the client address. The headers describe whichever has less left, so
honouring Retry-After always clears the window that bound.
- `default` — Any status this operation does not list, in the same envelope.

A 5xx means the request may or may not have applied. Retry it with the SAME
Idempotency-Key: that is the only way to find out without risking a duplicate,
and it is what the key is for.

A few 4xx conditions arrive here rather than as a listed status because they
depend on the merchant's plan or on a module being wired: 402 when a quota or a
plan limit is reached, and 503 when a capability the route needs is not
configured on this deployment. Both carry a `code` naming which.

## Example

```bash
curl --request GET \
  --url 'https://api.mercemur.com/api/v1/marketing-flow-runs' \
  --header 'Authorization: Bearer <token>'
```