Read one approval run (status)
Polling snapshot: the same current record or collection as the corresponding read endpoint, including its state and progress. List filters, defaults and pagination also apply here. This is not an event history or a changes-since feed. Poll at a sensible interval (start with 30 seconds), respect Retry-After on 429 and stop when the required terminal state is reached.
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/status
Request
- Base URL: https://api.custodo.ai
- URL: https://api.custodo.ai/api/v1/rest/workflow/instances/{id}/status
- Auth: HTTP bearer
Path parameters
Query parameters
concise (default) returns the fields you need to answer a question; detailed adds related records and costs more context.
Headers
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.
Changes
No recorded changes to this operation across all 1 revision of this API.