---
title: "Retrieve a phone number business username"
method: GET
path: "/whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername"
tags: ["WhatsApp Phone Numbers"]
---

# Retrieve a phone number business username

`GET /whatsapp/phoneNumbers/{wabaId}/{phoneNumber}/businessUsername`

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.

## Path parameters

- `wabaId` string, required
- `phoneNumber` string, required

## Response `200`

Successfully retrieved the object.

- WhatsappBusinessUsername — Business Username state for a WhatsApp business phone number.
  - `id` string — Phone number ID.
  - `wabaId` string — WhatsApp Business Account ID.
  - `phoneNumber` string — Phone number in [E.164](https://en.wikipedia.org/wiki/E.164) format.
  - `displayPhoneNumber` string — Display phone number.
  - `businessUsername` string — 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.
  - `requestedBusinessUsername` string — Last requested Business Username that is still under review. This value can coexist with an active `businessUsername` while the new request is pending.
  - `businessUsernameUpdatedAt` string, date-time — The time when the Business Username state was last updated.

## Other responses

- `404` — The requested resource does not exist.

---

[API](https://skmtc.dev/ycloud/apis/ycloud-api.md) · [All operations](https://skmtc.dev/ycloud/apis/ycloud-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ycloud/ycloud-api/revisions/4e13d3ca9df8/schema)