Skip to main content
GET
/
whatsapp
/
flows
List flows
curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/flows \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "meta_flow_id": "<string>",
      "name": "<string>",
      "status": "draft",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "json_version": "<string>",
      "data_api_version": "<string>",
      "business_account_id": "<string>",
      "preview_url": "<string>",
      "published_at": "2023-11-07T05:31:56Z",
      "last_synced_at": "2023-11-07T05:31:56Z",
      "data_endpoint_function_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "phone_number_id": "<string>",
      "data_endpoint_url": "<string>",
      "has_data_endpoint": true,
      "flows_encryption_configured": true
    }
  ],
  "meta": {
    "page": 2,
    "per_page": 2,
    "total_pages": 1,
    "total_count": 1
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
status
enum<string>

Filter by status

Available options:
draft,
published
​
business_account_id
string

Filter by WABA ID

​
phone_number_id
string

Filter by phone number

​
name_contains
string

Filter by name substring

​
created_after
string<date-time>
​
created_before
string<date-time>
​
per_page
integer
default:20
Required range: x >= 1
​
page
integer
default:1
Required range: x >= 1

Response

Success

​
data
object[]
required
​
meta
object
required