List flows (phone number scoped) - Kapso Documentation

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..."
    }
  }
}

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 Integrations > API keys.

Path Parameters

phone_number_id

string

required

WhatsApp Business Phone Number ID

Response

Flows retrieved successfully

data

object[]

Show child attributes

paging

object

Show child attributes

Create flow (phone number scoped)Create a new WhatsApp Flow for a phone number. **Proxy endpoint**: Proxies directly to Meta Graph API. **Note**: Requires WhatsappConfig with matching phone_number_id.

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..."
    }
  }
}