Skip to navigation

List runs

View as Markdown

Lists your organization’s runs, newest first.

Every run created through /v1 appears here — extractions, parses, redactions, fills, signatures and pipelines alike — so this is the answer to “what has my integration been doing?”.

Filtering:

ParameterEffect
objectOne kind of run, e.g. extract_run
statusOne state, e.g. needs_input
metadata.<key>=<value>Exact match on the metadata you attached at create — up to 3 pairs, combined with AND
GET /v1/runs?object=extract_run&status=processed&metadata.customerId=cus_42&limit=50

Paging. Up to 50 rows per page. When has_more is true, pass the returned cursor back as ?cursor= for the next page; treat it as opaque.

This listing is eventually consistent — a row can lag a second or two behind the run itself. GET /v1/runs/{id} reads the run directly and is always authoritative.

Authentication

AuthorizationBearer

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

Query parameters

objectenumOptional

Only runs of this kind — extract_run, parse_run, redact_run, fill_run, sign_run, classify_run, split_run or pipeline_run.

statusenumOptional
Only runs in this state.
limitintegerOptional1-50Defaults to 20

How many runs to return, 1–50.

cursorstringOptional>=1 character

The cursor from the previous page. Opaque — pass it back unchanged.

Response

The runs.
object"list"
datalist of objects
has_moreboolean
cursorstringOptional

Errors

400
Bad Request Error
429
Too Many Requests Error