Skip to main content
GET
/
v1
/
organization
/
whatsapp
/
phone-numbers
/
{phoneNumberId}
/
business-profile
cURL
curl --request GET \
  --url https://api.buildwithchirp.com/v1/organization/whatsapp/phone-numbers/{phoneNumberId}/business-profile \
  --header 'Authorization: Bearer <token>'
{
  "about": "<string>",
  "address": "<string>",
  "description": "<string>",
  "email": "jsmith@example.com",
  "profilePictureUrl": "<string>",
  "websites": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
phoneNumberId
string
required

WhatsApp phone number ID (internal Chirp ID)

Example:

"wapn_2DbBs7GWhGvVNJGrDXr5RG0mBWI"

Response

Business profile retrieved successfully

​
about
string | null
required
​
address
string | null
required
​
description
string | null
required
​
email
string<email> | null
required
​
profilePictureUrl
string<uri> | null
required
​
websites
string<uri>[] | null
required
​
vertical
enum<string> | null
required
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