Skip to main content
GET
/
flows
/
{flow_id}
/
definition
Get flow with definition
curl --request GET \
  --url https://app.kapso.ai/api/v1/flows/{flow_id}/definition \
  --header 'X-API-Key: <api-key>'
{
  "data": {
    "id": "flow-123abc",
    "name": "Customer Onboarding Flow",
    "description": "Automated flow for onboarding new customers",
    "status": "active",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    },
    "last_executed_at": "2023-11-07T05:31:56Z",
    "execution_count": 42,
    "definition": {
      "nodes": [
        {
          "id": "start_node_1",
          "type": "flow-node",
          "position": {
            "x": 100,
            "y": 200
          },
          "data": {
            "nodeType": "start",
            "config": {},
            "displayName": "Start"
          }
        }
      ],
      "edges": [
        {
          "id": "edge_1",
          "source": "start_node_1",
          "target": "send_text_1",
          "label": "next",
          "type": "default",
          "flow_condition_id": "<string>"
        }
      ]
    },
    "whatsapp_configs": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "Main WhatsApp Config",
        "phone_number": "+1234567890"
      }
    ]
  }
}

Documentation Index

Fetch the complete documentation index at: https://kapso-1adbad2d.mintlify.app/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Path Parameters

​
flow_id
string<uuid>
required

Response

Flow with complete definition

​
data
object