Contacts

Look up a number's WhatsApp profile

get/v1/accounts/{account_id}/profiles/{phone}

Request

  • Base URL: https://api.whatsmcp.com
  • URL: https://api.whatsmcp.com/v1/accounts/{account_id}/profiles/{phone}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

account_idstring required
phonestring required

the number to look up, international form

Response

OK

aboutstring

the peer's status text, when they let this account see it

is_businessboolean

true or false when known; ABSENT means the lookup could not establish it (see note) — absence is not a no

jidstring
namestring

the best available public name

name_sourcestring

business or none — a verified business name is vouched for by WhatsApp; "none" means nothing public is published

notestring
on_whatsappboolean required

false means the number is not registered on WhatsApp at all

phonestring
picture_urlstring

a WhatsApp-hosted URL that expires; fetch it promptly

Changes

No recorded changes to this operation across all 1 revision of this API.