Sign in

v1

latestOpenAPI 3.0.02026-07-2491237338.9 KB
WhatsApp Phone Numbers

Retrieve a phone number business username

Retrieves the Business Username state for a WhatsApp business phone number. The response reflects YCloud's latest known phone number state. If the phone number has no locally stored Business Username state, YCloud may sync the current username state from Meta before returning the response.

get/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername

Path parameters

wabaIdstring required
Example:whatsapp-business-account-id

WhatsApp Business Account ID.

phoneNumberstring required
Example:+16315551111

Phone number in E.164 format.

Response

Successfully retrieved the object.

idstring

Phone number ID.

wabaIdstring

WhatsApp Business Account ID.

phoneNumberstring

Phone number in E.164 format.

displayPhoneNumberstring

Display phone number.

businessUsernamestring

Active Business Username. The value is a plain username without @.

businessUsernameStatus'not_set' | 'active' | 'pending_review' | 'reserved'

Business Username state for a WhatsApp business phone number.

  • not_set: No active or pending Business Username exists.
  • active: A Business Username is active.
  • reserved: A requested Business Username is reserved by Meta and may still be under review.
  • pending_review: Legacy compatibility value for an under-review request. New writes use reserved. If an active username exists while a new request is reserved or under review, businessUsernameStatus is reserved, businessUsername contains the still-active username, and requestedBusinessUsername contains the requested username.
requestedBusinessUsernamestring

Last requested Business Username that is still under review. This value can coexist with an active businessUsername while the new request is pending.

businessUsernameUpdatedAtstring date-time

The time when the Business Username state was last updated.

Example response

{
  "id": "1234567890123456",
  "wabaId": "whatsapp-business-account-id",
  "phoneNumber": "+16315551111",
  "displayPhoneNumber": "+1 631-555-1111",
  "businessUsername": "acme.support",
  "requestedBusinessUsername": "acme.help",
  "businessUsernameUpdatedAt": "2026-05-26T12:00:00.000Z"
}