Workflows

Get workflow variables

Retrieve all variables available in a workflow, including both fixed system variables and variables discovered from execution history.

Returns two categories of variables:

Fixed variables: Built-in system and context variables always available (flow_id, started_at, channel, phone_number, etc.)
Discovered variables: User-defined variables observed during workflow executions, with sample values and usage statistics

Use this endpoint to:

Understand what variables are available for use in workflow steps
Review variable types and sample values for debugging
Build autocomplete for variable references in workflow editors

GET

workflows

{workflow_id}

variables

Get workflow variables

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

{
  "data": {
    "fixed": {
      "system": {
        "system.flow_id": {
          "type": "string",
          "description": "Flow identifier",
          "always_available": true
        },
        "system.started_at": {
          "type": "datetime",
          "description": "Flow execution start time",
          "always_available": true
        }
      },
      "context": {
        "context.channel": {
          "type": "string",
          "description": "Communication channel (api or whatsapp)",
          "always_available": false
        },
        "context.phone_number": {
          "type": "string",
          "description": "Contact phone number",
          "always_available": false
        }
      }
    },
    "discovered": {
      "system": [],
      "context": [],
      "vars": [
        {
          "path": "vars.user_name",
          "name": "user_name",
          "type": "string",
          "sample_values": [
            "Alice",
            "Bob"
          ],
          "usage_count": 42,
          "last_seen_at": "2025-01-15T10:30:00.000Z",
          "reference": "{{vars.user_name}}"
        }
      ]
    }
  }
}

Authorizations

X-API-Key

string

header

required

Path Parameters

workflow_id

string<uuid>

required

Workflow identifier

Response

Variables retrieved successfully

Workflow variables including fixed system variables and discovered user variables

data

object

required

Show child attributes

List workflow executionsRetrieve 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/{id} 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 workflow variables

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

{
  "data": {
    "fixed": {
      "system": {
        "system.flow_id": {
          "type": "string",
          "description": "Flow identifier",
          "always_available": true
        },
        "system.started_at": {
          "type": "datetime",
          "description": "Flow execution start time",
          "always_available": true
        }
      },
      "context": {
        "context.channel": {
          "type": "string",
          "description": "Communication channel (api or whatsapp)",
          "always_available": false
        },
        "context.phone_number": {
          "type": "string",
          "description": "Contact phone number",
          "always_available": false
        }
      }
    },
    "discovered": {
      "system": [],
      "context": [],
      "vars": [
        {
          "path": "vars.user_name",
          "name": "user_name",
          "type": "string",
          "sample_values": [
            "Alice",
            "Bob"
          ],
          "usage_count": 42,
          "last_seen_at": "2025-01-15T10:30:00.000Z",
          "reference": "{{vars.user_name}}"
        }
      ]
    }
  }
}