Skip to main content
Get a workflow run

Authorizations

Authorization
string
header
required

Personal API key. Send X-Organization-Id. The required cumulative level is listed in x-watchdog-permission.

Headers

X-Organization-Id
string

Required for personal API keys. Target one organization you have access to. Migrated keys may omit it to use their original organization. For Clerk sessions, it must match the active organization.

Path Parameters

id
string<uuid>
required

Response

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

id
string<uuid>
required

One operation containing zero or more work items. Explicit retry creates a new run.

retry_of_run_id
string<uuid> | null
required
type
enum<string>
required
Available options:
organization_currency_conversion,
document_extraction,
agreement_document_classification,
agreement_detail_suggestions,
invoice_import,
invoice_import_batch,
invoice_agreement_matching,
agreement_invoice_matching,
invoice_compliance_check,
agreement_compliance_check,
integration_sync,
alert_topic_reconciliation,
alert_topic_proposal,
agreement_context_suggestions,
agreement_price_import
resource
object
required

The business operation owning this execution; for invoice_import, the InvoiceImport.

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

Last product state change, excluding internal provider checks.

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