Skip to main content
Get a workflow run

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.

Path Parameters

id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, 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.

Response

One operation, its owning resource, progress, status, timestamps, and failure.

id
string<uuid>
required

Run ID. Retrying a run can create a new run with its own ID.

retry_of_run_id
string<uuid> | null
required
type
enum<string>
required
Available options:
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
resource
object
required

The resource this run belongs to.

status
enum<string>
required
Available options:
queued,
running,
completed,
completed_with_errors,
failed,
cancelled
progress
object
required

Counts of admitted items. total is null while more items may be discovered.

created_at
string<date-time>
required
updated_at
string<date-time>
required

When the run last changed.

started_at
string<date-time> | null
required
finished_at
string<date-time> | null
required
failure
object | null
required
label
string | null
required

Agreement title, invoice number, file name or integration name, when known.