General Documentation
Agents
Agent Executions
Test Suites
Projects
WhatsApp Conversations
Customers
WhatsApp Configs
Agent Test Chats
Conversation Assignments
WhatsApp Templates
WhatsApp Contact Notes
Agent Snapshots
Flows
List all flows
Returns a list of all flows for the authenticated project
GET
/
flows
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/flows \
--header 'X-API-Key: <api-key>'
Copy
{
"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
}
]
}
Authorizations
API key required for all endpoints
Query Parameters
Filter flows by status
Available options:
draft
, active
, archived
Response
200
application/json
A list of flows
The response is of type object
.
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/flows \
--header 'X-API-Key: <api-key>'
Copy
{
"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
}
]
}
Assistant
Responses are generated using AI and may contain mistakes.