Skip to main content
GET
/
{phone_number_id}
/
flows
List flows (phone number scoped)
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/v24.0/{phone_number_id}/flows \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "flow-1",
      "name": "my first flow",
      "status": "DRAFT",
      "categories": [
        "SIGN_UP"
      ],
      "validation_errors": []
    },
    {
      "id": "flow-2",
      "name": "my second flow",
      "status": "PUBLISHED",
      "categories": [
        "SURVEY"
      ],
      "validation_errors": []
    }
  ],
  "paging": {
    "cursors": {
      "before": "QVFIUnpKT...",
      "after": "QVFIUnZAWV..."
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.kapso.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Project API key for authentication. This is the recommended authentication method.

Get your API key from the Kapso dashboard under Project Settings > API Keys.

Path Parameters

​
phone_number_id
string
required

WhatsApp Business Phone Number ID

Response

Flows retrieved successfully

​
data
object[]
​
paging
object