Workflows

List workflow executions

Retrieve execution history for a workflow. Executions are returned in reverse chronological order (most recent first). Use query parameters to filter by status, time range, or cursor.

Response: Returns summary data (id, status, tracking_id, timestamps, workflow, current_step). Does not include execution_context or events. Use GET /workflow_executions/ to retrieve full execution details.

Pagination: Use limit, after, and before. Pagination cursors are returned in the paging object.

Common use cases:

Monitor active executions for a workflow
Review failed executions for debugging
Audit execution history over time
Find waiting executions that need user input

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>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
        }
      }
    }
  ],
  "paging": {
    "cursors": {
      "before": "<string>",
      "after": "<string>"
    },
    "next": "<string>",
    "previous": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

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

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

limit

integer

default:20

Maximum number of results per cursor-paginated page (default 20, max 100).

Required range: 1 <= x <= 100

before

string

Cursor for the previous page (Base64 encoded).

after

string

Cursor for the next page (Base64 encoded).

Response

Executions retrieved successfully

List of workflow executions with cursor pagination metadata

data

object[]

required

Show child attributes

paging

object

required

Show child attributes

List workflow executions

curl --request GET \
  --url https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions \
  --header 'X-API-Key: <api-key>'

const options = {method: 'GET', headers: {'X-API-Key': '<api-key>'}};

fetch('https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.kapso.ai/platform/v1/workflows/{workflow_id}/executions")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "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
        }
      }
    }
  ],
  "paging": {
    "cursors": {
      "before": "<string>",
      "after": "<string>"
    },
    "next": "<string>",
    "previous": "<string>"
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

Overview

WhatsApp API

Platform API

Workflows API

Kapso Agent API

List workflow executions

Authorizations

Path Parameters

Query Parameters

Response