Skip to main content
GET
/
v1
/
organization
/
whatsapp
/
phone-numbers
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/whatsapp/phone-numbers \
  --header 'Authorization: Bearer <token>'
{
  "phoneNumbers": [
    {
      "id": "wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
      "displayPhoneNumber": "<string>",
      "metaPhoneNumberId": "<string>",
      "metaBusinessAccountId": "<string>",
      "verified": true,
      "qualityRating": "<string>",
      "isTestNumber": true,
      "cloudApiRegistered": true,
      "businessProfile": {
        "id": "<string>",
        "metaWabaId": "<string>",
        "businessName": "<string>"
      },
      "apps": [
        {
          "appId": "<string>",
          "appName": "<string>",
          "appSlug": "<string>"
        }
      ],
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "totalCount": 123
}

Authorizations

Authorization
string
header
required

Admin API key (format: sk_admin_*) for organization-level operations

Query Parameters

limit
number
default:20
Required range: 1 <= x <= 100
offset
number | null
default:0
Required range: x >= 0
isTestNumber
enum<string>
Available options:
true,
false

Response

List of WhatsApp phone numbers

phoneNumbers
object[]
required
totalCount
number
required