List runs

GET

/v1/runs

GET

/v1/runs

$ curl -G https://api.cloudraker.com/v1/runs \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d object=extract_run \
>      -d status=processed \
>      -d limit=50

1 {
2   "object": "list",
3   "data": [
4     {
5       "object": "extract_run",
6       "id": "run_8f3b2a1c-4d7e-4a9f-9b2e-1a2c3d4e5f6a",
7       "status": "processed",
8       "createdAt": "2024-06-10T15:22:30Z",
9       "expiresAt": "2024-07-10T15:22:30Z",
10       "statusUrl": "https://dashboard.cloudraker.com/runs/run_8f3b2a1c-4d7e-4a9f-9b2e-1a2c3d4e5f6a/status",
11       "metadata": {
12         "customerId": "cus_42",
13         "project": "invoice_processing"
14       },
15       "kept": {
16         "spaceId": "space_9d8f7e6c5b4a3",
17         "keptAt": "2024-06-10T15:23:00Z"
18       }
19     }
20   ],
21   "has_more": true,
22   "cursor": "eyJwYWdlIjoxLCJpZCI6InJ1bl85MTIzNDU2In0="
23 }

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:

Parameter	Effect
`object`	One kind of run, e.g. `extract_run`
`status`	One 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.

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:** | Parameter | Effect | | --- | --- | | `object` | One kind of run, e.g. `extract_run` | | `status` | One 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. <Note> This listing is eventually consistent — a row can lag a second or two behind the run itself. [GET /v1/runs/{id}](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run) reads the run directly and is always authoritative. </Note>

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 or pipeline_run.

statusenumOptional

Only runs in this state.

limitintegerOptional1-50Defaults to 20

How many runs to return, 1–50. Defaults to 20.

cursorstringOptional>=1 character

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

Response

The runs.

object"list"

datalist of objects

has_moreboolean

cursorstring

Errors

400

Bad Request Error

429

Too Many Requests Error