Skip to main content
List workflow runs

Authorizations

Authorization
string
header
required

Personal API key sent as a bearer token, together with X-Organization-Id. The key must have at least the access level the endpoint requires (read, write or admin).

Headers

X-Organization-Id
string

The organization to act in. Required for personal API keys; list the organizations you can access with GET /v1/organizations.

Query Parameters

fields
string

Return only these fields of each row, comma-separated; use dots for nested fields, such as resource.type. id is always returned. Fields: id, retry_of_run_id, type, resource, status, progress, created_at, updated_at, started_at, finished_at, failure, label.

limit
integer
default:50

Maximum number of results per page.

Required range: 1 <= x <= 1000
cursor
string

Opaque next_cursor from the previous page. Keep the same filters and sort; omit for the first page.

Maximum string length: 4096
statuses
string

Comma-separated statuses: queued, running, completed, completed_with_errors, failed, cancelled. Omit to include all statuses, including terminal runs.

Maximum string length: 4000
types
string

Comma-separated workflow types: party_merge, organization_currency_conversion, document_extraction, document_index, agreement_document_classification, agreement_detail_suggestions, invoice_import, invoice_import_batch, invoice_agreement_matching, invoice_credit_note_matching, agreement_invoice_matching, invoice_compliance_check, agreement_compliance_check, integration_sync, integration_capture, alert_topic_reconciliation, alert_topic_proposal, agreement_context_suggestions, agreement_price_import, agreement_document_import.

Maximum string length: 4000
created_from
string<date-time>

Inclusive creation time, as a UTC timestamp with at most six fractional digits.

Maximum string length: 27
created_before
string<date-time>

Exclusive creation time, as a UTC timestamp with at most six fractional digits.

Maximum string length: 27
resource_type
enum<string>
Available options:
invoice_import,
workflow_run,
invoice,
agreement,
document,
integration,
agreement_price_import
resource_id
string<uuid>

Owner ID; requires resource_type.

ids
string

Comma-separated run IDs, at most 100. Unknown IDs are ignored.

Maximum string length: 4000

Response

A page of runs.

data
object[]
required
Maximum array length: 1000
next_cursor
string | null
required