Retrieve workflow

Get workflow metadata, status, and execution stats for a specific workflow. This endpoint does not include the expanded canvas definition payload.

Use this endpoint to:

• Retrieve workflow metadata before a simple update
• Check workflow status and execution count
• Inspect timestamps, lock version, and execution activity

Use GET /workflows/{workflow_id}/definition when you need the editor payload with nodes, edges, embedded project data, and WhatsApp configs.

GET /workflows/{workflow_id}

Retrieve workflow

cURL

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

200

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "status": "draft",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "lock_version": 123,
    "message_debounce_seconds": 123,
    "inbound_message_read_mode": "disabled",
    "project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "execution_count": 1,
    "last_executed_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

X-API-Key · string · header · required

Path Parameters

workflow_id · string<uuid> · required

Workflow identifier

Response

200

application/json

Workflow details retrieved successfully

Single workflow response

data · object · required

Show child attributes