curl --request GET \
--url https://api.social-api.ai/v1/platforms/whatsapp/phone-numbers/{id}/business-profile \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.social-api.ai/v1/platforms/whatsapp/phone-numbers/{id}/business-profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.social-api.ai/v1/platforms/whatsapp/phone-numbers/{id}/business-profile"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"about": "Reach us 9-5 weekdays.",
"address": "1 Hacker Way, Menlo Park, CA",
"description": "Acme Corp customer support.",
"email": "support@acme.com",
"messaging_product": "whatsapp",
"profile_picture_url": "https://cdn.example.com/logo.png",
"vertical": "RETAIL",
"websites": [
"https://acme.com"
]
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}Get a WhatsApp Business Profile
Returns the public business profile for a WhatsApp phone number, including about text, address, description, contact email, websites, and vertical. The profile is visible to customers in the WhatsApp chat header.
curl --request GET \
--url https://api.social-api.ai/v1/platforms/whatsapp/phone-numbers/{id}/business-profile \
--header 'Authorization: <api-key>'const options = {method: 'GET', headers: {Authorization: '<api-key>'}};
fetch('https://api.social-api.ai/v1/platforms/whatsapp/phone-numbers/{id}/business-profile', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.social-api.ai/v1/platforms/whatsapp/phone-numbers/{id}/business-profile"
headers = {"Authorization": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"about": "Reach us 9-5 weekdays.",
"address": "1 Hacker Way, Menlo Park, CA",
"description": "Acme Corp customer support.",
"email": "support@acme.com",
"messaging_product": "whatsapp",
"profile_picture_url": "https://cdn.example.com/logo.png",
"vertical": "RETAIL",
"websites": [
"https://acme.com"
]
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}{
"error": {
"code": "resource.not_found",
"message": "Account not found",
"meta": {}
}
}Authorizations
Prefix your API key with "Bearer ". Example: Authorization: Bearer sapi_key_...
Path Parameters
WhatsApp phone number platform ID (numeric ID, not the E.164 number)
Response
Business profile
About is the profile tagline shown in the chat header.
"Reach us 9-5 weekdays."
Address is the business address (max 256 characters).
"1 Hacker Way, Menlo Park, CA"
Description is the business description.
"Acme Corp customer support."
Email is the contact email.
"support@acme.com"
MessagingProduct is always "whatsapp".
"whatsapp"
ProfilePictureURL is the public URL of the current profile picture (read-only; use profile_picture_handle to update).
"https://cdn.example.com/logo.png"
Vertical is the business category.
OTHER, AUTO, BEAUTY, APPAREL, EDU, ENTERTAIN, EVENT_PLAN, FINANCE, GROCERY, GOVT, HOTEL, HEALTH, NONPROFIT, PROF_SERVICES, RETAIL, TRAVEL, RESTAURANT, ALCOHOL "RETAIL"
Websites lists the business websites (max 2).
["https://acme.com"]