Workflows

Read one approval run

One run: what it is about, which flow it follows, its status, and every task with who decided what. detailed adds the discussion comments. Use this to explain WHY something is stuck.

Examples

  • Why is that invoice still pending? GET /api/v1/rest/workflow/instances/11111111-2222-4333-8444-555555555555
get/api/v1/rest/workflow/instances/{id}

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/workflow/instances/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

Query parameters

response_format'concise' | 'detailed'

concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.

Headers

X-Tenant-Idstring uuid

The organisation to act in. An API key is bound to exactly one, so this is optional for a key and must match the one it was minted for.

Response

Done. data is the tool’s own answer.

oktrue required
dataunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.