Skip to main content
GET
/
whatsapp_configs
List WhatsApp configs
curl --request GET \
  --url https://app.kapso.ai/api/v1/whatsapp_configs \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "config-123abc",
      "name": "Client WhatsApp",
      "display_name": "Client WhatsApp (+1234567890)",
      "phone_number_id": "1234567890",
      "business_account_id": "98765432109",
      "kind": "production",
      "display_phone_number": "+56 9 61461262",
      "display_phone_number_normalized": "56961461262",
      "is_coexistence": true,
      "webhook_verified_at": "2023-11-07T05:31:56Z",
      "customer_id": "customer-456def",
      "inbound_processing_enabled": true,
      "calls_enabled": false,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 5,
    "total_count": 100
  }
}

Authorizations

​
X-API-Key
string
header
required

API key required for all endpoints

Query Parameters

​
page
integer
default:1
Required range: x >= 1
​
per_page
integer
default:20
Required range: 1 <= x <= 100
​
business_account_id
string

Filter by WhatsApp Business Account ID

​
q[business_account_id_eq]
string

Filter by exact WhatsApp Business Account ID (Ransack syntax)

​
q[name_cont]
string

Filter by name containing string

​
q[created_at_gteq]
string<date-time>

Filter by created date >= (ISO 8601 format)

​
q[created_at_lteq]
string<date-time>

Filter by created date <= (ISO 8601 format)

Response

List of WhatsApp configurations

​
data
object[]
​
meta
object