Skip to main content
GET
/
workflows
/
{workflow_id}
/
executions
List workflow executions
curl --request GET \
  --url https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "running",
      "started_at": "2023-11-07T05:31:56Z",
      "last_event_at": "2023-11-07T05:31:56Z",
      "ended_at": "2023-11-07T05:31:56Z",
      "tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "whatsapp_conversation_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "workflow": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "status": "<string>"
      },
      "current_step": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "identifier": "<string>",
        "stepable_type": "<string>",
        "position": {
          "x": 123,
          "y": 123
        }
      }
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 2,
    "total_pages": 1,
    "total_count": 1
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
workflow_id
string<uuid>
required

Workflow identifier

Query Parameters

​
status
enum<string>

Filter by execution status

Available options:
running,
waiting,
ended,
failed,
handoff
​
waiting_reason
string

Filter waiting executions by reason (e.g., 'wait_for_response', 'timeout')

​
created_after
string<date-time>

Only return executions started on or after this timestamp

​
created_before
string<date-time>

Only return executions started on or before this timestamp

​
whatsapp_conversation_id
string<uuid>

Filter by associated WhatsApp conversation

​
per_page
integer
default:20

Number of results per page

Required range: 1 <= x <= 100
​
page
integer
default:1

Page number for pagination

Required range: x >= 1

Response

Executions retrieved successfully

List of workflow executions with pagination metadata

​
data
object[]
required
​
meta
object
required