List Runs

List automation runs for a workflow, with compact contact data in each run.
Filter by current_step_id to see who is at a step now, including paused runs.
Multiple step IDs are ORed; contact_id and status filters are combined with AND.
Each result is one run, so the same contact can appear more than once.
Without a step filter, runs across all statuses are included.
Only standard automation runs are returned (survey runs excluded).
Pagination is a live view, not a snapshot of membership.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Integer id or obfuscated public_id of the workflow.

Query Params
string

ID of item after which the collection should be returned. More examples and info about pagination in our guides.

integer
≥ 1
Defaults to 20

Records per page. Defaults to 20; raise it up to 100 for bulk reads. A larger value returns 100 records. Zero, a negative or a non-integer value is a 422. The Link next-page URL keeps the value, so a client following it keeps the page size. More in our guides.

string
enum

Sort order of a list response. Use 'desc' to reverse the default 'asc' (ascending) sort order. Examples in our guides.

Allowed:
string
enum

Sort property of a list response. The default is id and thus the created_at order.
If you sort by other properties, we additionally sort by id implicitly as a secondary sort property, so that you can rely on the sort order to be deterministic even if the main sort property ends up with the same values.

Allowed:
filter
object

Filter current membership by current_step_id and/or narrow by the existing single-value
contact_id (integer id or public_id) and status filters.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json