Docs
API ReferenceReferenceFlows

Get a flow

GET
/flows/{flowId}

One published Flow with its inputs and their JSON Schema. A Flow in another organization, an unpublished one, or an id that is an Agent or App is the same 404. Requires the flows:read scope.

AuthorizationBearer <token>

An organization API key, created from a Portal's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).

In: header

Path Parameters

flowId*string
Formatuuid

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/flows/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "flow": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "description": "string",    "inputs": [      {        "key": "string",        "label": "string",        "description": "string",        "type": "string",        "required": true,        "options": [          "string"        ]      }    ],    "inputSchema": {}  }}