Skip to main content
GET
/
whatsapp
/
phone_numbers
List phone numbers
curl --request GET \
  --url https://api.kapso.ai/platform/v1/whatsapp/phone_numbers \
  --header 'X-API-Key: <api-key>'
{
  "data": [
    {
      "id": "1234567890",
      "internal_id": "4a5b6c7d-8e9f-0a1b-2c3d-4e5f6a7b8c9d",
      "phone_number_id": "1234567890",
      "name": "Support Line",
      "business_account_id": "98765432109",
      "is_coexistence": false,
      "inbound_processing_enabled": true,
      "calls_enabled": false,
      "webhook_verified_at": "2025-01-14T15:10:00Z",
      "created_at": "2025-01-14T15:00:00Z",
      "updated_at": "2025-01-14T15:10:00Z",
      "display_name": "Support Line",
      "display_phone_number": "+1 555-123-4567",
      "display_phone_number_normalized": "15551234567",
      "verified_name": "Acme Corp",
      "quality_rating": "GREEN",
      "throughput_tier": "TIER_10K",
      "whatsapp_business_manager_messaging_limit": "10000",
      "customer_id": "3f2e1d0c-9b8a-7f6e-5d4c-3b2a1f0e9d8c",
      "code_verification_status": "COMPLETED",
      "name_status": "APPROVED",
      "status": "CONNECTED",
      "is_official_business_account": false,
      "is_pin_enabled": true
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20,
    "total_pages": 1,
    "total_count": 1
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
phone_number_id
string

Filter by Meta phone number ID

​
business_account_id
string

Filter by WABA ID

​
customer_id
string<uuid>
​
messaging_enabled
boolean
​
name_contains
string
​
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