Skip to main content
GET
Your WhatsApp number

Authorizations

Authorization
string
header
required

Your API key, e.g. gr_live_…

Response

The number.

display_number
string
display_name
string
name_status
string | null
quality
enum<string>
Available options:
green,
yellow,
red,
unknown
messaging_limit
any
status
string | null
can_send
boolean
restriction_reason
string | null

WhatsApp's reason, exactly as WhatsApp sent it, while the number is restricted, flagged or banned, or a ban is scheduled; otherwise null. Several restrictions are separated by commas. The codes: RESTRICTED_BIZ_INITIATED_MESSAGING — the number can't start new chats; RESTRICTED_CUSTOMER_INITIATED_MESSAGING — the number can't reply to customers; RESTRICTED_ADD_PHONE_NUMBER_ACTION — no new numbers can be added to the account; a policy code such as ADULT — the account broke WhatsApp's policy of that kind; DISABLE — the account is disabled; SCHEDULE_FOR_DISABLE — the account will be disabled on the date in restriction_until. Any other code is passed on as WhatsApp sent it.

restriction_until
string<date-time> | null

When the restriction ends, or the day a scheduled disable starts (India time); null when WhatsApp gave no date.

restricted_at
string<date-time> | null

When WhatsApp restricted, flagged or banned the number (India time); otherwise null.

connected_at
string<date-time> | null

When the number was connected to GetReply (India time).

new_name
string | null

A new display name you asked for; null when there is none.

new_name_status
enum<string> | null

The new name's status: approved, pending_review, declined, or expired (approved but not used within 14 days); null when there is none.

Available options:
approved,
pending_review,
declined,
expired,
null