Workflows

Read one flow’s definition

The authored definition of one flow — its stages (each with its id), approvers, custom fields (each with its key) and (Premium) automated steps — exactly as the builder reads it, un-resolved table sources included. Read it before workflow_update_flow, which needs those ids and keys; to start a run use workflow_start.

Examples

  • What does the invoice approval flow actually do? GET /api/v1/rest/workflow/flows/33333333-4444-4555-8666-777777777777
get/api/v1/rest/workflow/flows/{id}

Request

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

Path parameters

idstring uuid required

From workflow_list_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.