Authorizations
API key required for all endpoints
Path Parameters
Response
Flow with complete 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"
}
]
}
}
Returns flow details including the complete definition structure
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"
}
]
}
}
API key required for all endpoints
Flow with complete definition
Show child attributes
Was this page helpful?