Skip to main content
GET
/
v1
/
whatsapp
/
phone-numbers
/
{phoneNumberId}
/
business-profile
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/whatsapp/phone-numbers/{phoneNumberId}/business-profile \
  --header 'Authorization: Bearer <token>'
{
  "id": "wabp_2DbBs7GWhGvVNJGrDXr5RG0mBWI",
  "organizationId": "<string>",
  "metaWabaId": "<string>",
  "metaBusinessId": "<string>",
  "businessName": "Acme Corp",
  "tokenExpiresAt": "2023-11-07T05:31:56Z",
  "onboardingCompletedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "phoneNumbers": [
    {
      "id": "<string>",
      "displayPhoneNumber": "+15551234567",
      "metaPhoneNumberId": "<string>",
      "verified": true,
      "qualityRating": "GREEN"
    }
  ],
  "isTestProfile": true,
  "about": "We are a company that sells things",
  "address": "123 Main St, San Francisco, CA 94105",
  "description": "We provide excellent products and services...",
  "email": "[email protected]",
  "profilePictureUrl": "https://example.com/profile.jpg",
  "websites": [
    "https://www.example.com",
    "https://shop.example.com"
  ],
  "vertical": "RETAIL"
}

Authorizations

​
Authorization
string
header
required

App API key (format: sk_live_app_* or sk_test_app_*) for app-level operations

Path Parameters

​
phoneNumberId
string
required

WhatsApp phone number ID (internal Chirp ID)

Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Business profile retrieved successfully

​
id
string
required

WhatsApp Business Profile ID

Example:

"wabp_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

​
organizationId
string
required
​
metaWabaId
string
required

Meta's WhatsApp Business Account ID

​
metaBusinessId
string | null
required

Meta's Business Portfolio ID

​
businessName
string | null
required

Business name from Meta

Example:

"Acme Corp"

​
tokenExpiresAt
string<date-time> | null
required

When the access token expires (null = never)

​
onboardingCompletedAt
string<date-time> | null
required

When onboarding was completed

​
createdAt
string<date-time>
required
​
phoneNumbers
object[]
required
​
isTestProfile
boolean
required

Whether this is a test profile (for test mode separation)

​
about
string | null
required

Short description (max 139 characters)

Example:

"We are a company that sells things"

​
address
string | null
required

Business address

Example:

"123 Main St, San Francisco, CA 94105"

​
description
string | null
required

Full business description

Example:

"We provide excellent products and services..."

​
email
string<email> | null
required

Business email address

Example:

"[email protected]"

​
profilePictureUrl
string<uri> | null
required

URL to the business profile picture

Example:

"https://example.com/profile.jpg"

​
websites
string<uri>[] | null
required

Business websites (max 2)

Example:
[
  "https://www.example.com",
  "https://shop.example.com"
]
​
vertical
enum<string> | null
required

Business category/vertical

Available options:
UNDEFINED,
OTHER,
AUTO,
BEAUTY,
APPAREL,
EDU,
ENTERTAIN,
EVENT_PLAN,
FINANCE,
GROCERY,
GOVT,
HOTEL,
HEALTH,
NONPROFIT,
PROF_SERVICES,
RETAIL,
TRAVEL,
RESTAURANT,
NOT_A_BIZ
Example:

"RETAIL"