Workflows

List every run in the tenant (module 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.

The tenant-wide monitoring list — every run, not only the caller’s own, newest and highest-priority first. Requires workflow:manage plus the workflow.monitoring feature (Premium). For "my own runs" call workflow_run_counts or workflow_list_tasks instead; this tool is the dashboard over everybody’s runs.

Examples

  • Show me every approval still running GET /api/v1/rest/workflow/status?status=running
get/api/v1/rest/workflow/status

Request

  • Base URL: https://api.custodo.ai
  • URL: https://api.custodo.ai/api/v1/rest/workflow/status
  • Auth: HTTP bearer

Query parameters

status'running' | 'completed' | 'rejected' | 'expired' | 'cancelled' | 'failed' | 'returned'

Filter to one status.

flow_idstring uuid

Filter to runs of one flow.

limitinteger

Rows to return, 1–100. Default 20.

cursorstring

Opaque cursor from a previous call’s nextCursor, to continue.

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.