Workflows

List the flows I may start, or all the flows I author

scope startable (default): approval flows this member may start manually, with the custom fields each one collects — call this before workflow_start, the field names are the organisation’s own. scope authoring (flow authors only): EVERY flow the member may edit, switched-off ones included, with id, trigger and state — call this to find a flow to read or change (a flow just created is switched off, so the startable list does not show it).

Examples

  • What approvals can we start? GET /api/v1/rest/workflow/flows
  • Change the invoice flow we set up yesterday GET /api/v1/rest/workflow/flows?scope=authoring
get/api/v1/rest/workflow/flows

Request

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

Query parameters

scope'startable' | 'authoring'

authoring needs workflow:flows:manage and includes inactive flows.

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.