Skip to main content
GET
/
flows
/
{flow_id}
/
executions
List flow executions
curl --request GET \
  --url https://app.kapso.ai/api/v1/flows/{flow_id}/executions \
  --header 'X-API-Key: <api-key>'
{
  "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

​
X-API-Key
string
header
required

API key required for all endpoints

Path Parameters

​
flow_id
string<uuid>
required

Query Parameters

​
q[status_eq]
enum<integer>

Filter by status (0=running, 1=waiting, 2=ended, 3=failed)

Available options:
0,
1,
2,
3
​
q[started_at_gteq]
string<date-time>

Filter executions started on or after this date

​
q[started_at_lteq]
string<date-time>

Filter executions started on or before this date

Response

A list of flow executions

​
data
object[]
⌘I