Skip to main content
GET
/
{phone_number_id}
Get phone number details
curl --request GET \
  --url https://api.kapso.ai/meta/whatsapp/{phone_number_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "1906385232743451",
  "verified_name": "Jasper's Market",
  "display_phone_number": "+1 631-555-5555",
  "quality_rating": "GREEN"
}

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

Query Parameters

​
fields
string

Comma-separated list of fields to retrieve.

Available fields: id, verified_name, display_phone_number, quality_rating, code_verification_status, is_official_business_account, name_status, new_name_status, platform_type, throughput, account_mode, certificate, messaging_limit_tier

Example: fields=id,verified_name,display_phone_number,quality_rating,throughput,messaging_limit_tier

Response

Phone number details retrieved successfully

​
id
string

Phone number ID

​
verified_name
string

Verified business name associated with the phone number

​
display_phone_number
string

Phone number in international format

​
quality_rating
enum<string>

Quality rating based on message delivery.

  • GREEN: High quality
  • YELLOW: Medium quality
  • RED: Low quality
  • NA: Not yet determined
  • UNKNOWN: Status unknown
Available options:
GREEN,
YELLOW,
RED,
NA,
UNKNOWN
​
code_verification_status
string

Verification status of the phone number

​
is_official_business_account
boolean

Whether this is an official business account

​
name_status
string

Status of the business name

​
new_name_status
string

Status of pending name change

​
platform_type
string

Platform type (CLOUD_API, etc.)

​
throughput
object

Messaging throughput limits

​
account_mode
enum<string>

Account mode (SANDBOX for testing, LIVE for production)

Available options:
SANDBOX,
LIVE
​
certificate
string

Certificate status

​
messaging_limit_tier
string

Current messaging limit tier (TIER_50, TIER_250, TIER_1K, TIER_10K, TIER_100K, TIER_UNLIMITED)