Skip to main content
GET
Get user info
Returns a contact’s data: names, username, whether the account is Business (isBusiness) or Official API (isOfficial), about text (status) and picture (avatar). POST /api/v1/contacts/getuser returns the same response, with the parameters in the body.

WhatsApp Business profile

When the contact is a business account (WhatsApp Business app or Official API), the response carries data.businessProfile with the public business profile: description, email, address, websites, location, categories, business hours, linked Instagram and Facebook accounts, offerings and cover photo. The profile comes by default. It costs one extra query to WhatsApp (up to 10 s); if you don’t need it, turn it off with business=false (query) on GET or "business": false (body) on POST.
businessProfile only exists for business accounts and when the lookup succeeds. For a personal contact, with business=false or when WhatsApp does not answer in time, the key is absent — the rest of the contact arrives as usual. Treat the field as optional.

businessProfile fields

string
Business description
string
Public email
string
Address
string[]
Registered websites (empty list when there are none). Some businesses put their Instagram link here instead of linking the account.
object | null
{ latitude, longitude } of the location pinned on the profile, or null
object[]
Business categories: { id, name }
object
object | null
Linked Instagram account: { handle, followers, url }, or null
object | null
Linked Facebook page: { id, name, likes, url }, or null
object[]
Services and amenities checked on the profile, grouped by category: { category, items: [{ id, name, offered }] }
string
Cover photo. It is a signed WhatsApp CDN link that expires — download the image if you need to keep it.
string
catalog | shop | none
boolean
Whether the shopping cart is enabled
string
smb (WhatsApp Business app) | ent (API / hosted account)
string
Verification level reported by WhatsApp
string
Automation type reported by WhatsApp
string
When the business signed up, in RFC 3339, or empty when WhatsApp does not say
string
The same information as text, as WhatsApp displays it

Authorizations

Authorization
string
header
required

API Key for authentication. Format: <API_KEY>

Path Parameters

phone
string
required

Query Parameters

sessionId
string
required
Minimum string length: 1
async
avatar
string
force
string
preview
string
business
string

Response

200

Successful response