Skip to main content
Get a workflow run item

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
item_id
string<uuid>
required

Query Parameters

fields
string

Return only these fields, comma-separated; use dots for nested fields, such as failure.code. id is always returned. Fields: id, run_id, retry_of_item_id, label, resource, status, result, failure, created_at, updated_at, started_at, finished_at.

Response

The item. A failed item is returned with 200 and its failure details.

id
string<uuid>
required
run_id
string<uuid>
required
retry_of_item_id
string<uuid> | null
required
label
string | null
required

The name of the item: agreement title, invoice number, file name, integration name or provider invoice key, when known.

resource
object
required
status
enum<string>
required
Available options:
queued,
running,
completed,
skipped,
failed,
cancelled
result
object
required

The item’s result, shaped by workflow type. Null until the item completes or is skipped.

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