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
Flow Executions
List flow executions
Returns a list of executions for a specific flow
GET
/
flows
/
{flow_id}
/
executions
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/flows/{flow_id}/executions \
--header 'X-API-Key: <api-key>'
Copy
{
"data": [
{
"id": "exec-456def",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"last_event_at": "2023-11-07T05:31:56Z",
"tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_step": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Send Welcome Message",
"step_type": "message"
},
"execution_context": {},
"variables": {},
"flow": {
"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
Path Parameters
Query Parameters
Filter by status (0=running, 1=waiting, 2=ended, 3=failed)
Available options:
0
, 1
, 2
, 3
Filter executions started on or after this date
Filter executions started on or before this date
Response
200
application/json
A list of flow executions
The response is of type object
.
Copy
curl --request GET \
--url https://app.kapso.ai/api/v1/flows/{flow_id}/executions \
--header 'X-API-Key: <api-key>'
Copy
{
"data": [
{
"id": "exec-456def",
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"last_event_at": "2023-11-07T05:31:56Z",
"tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"current_step": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "Send Welcome Message",
"step_type": "message"
},
"execution_context": {},
"variables": {},
"flow": {
"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.