Skip to main content
POST
Get business profile

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
number
string
required

Phone number or JID of the business account to inspect.

Example:

"5511999999999"

Response

Success — provider-native response body.

WhatsApp Business profile. When the number is a business account isBusiness=true and the business fields are populated; otherwise isBusiness=false with the on-WhatsApp check fields.

isBusiness
boolean
required

Whether the number is a WhatsApp Business account.

wid
string

WhatsApp business ID (JID).

jid
string

WhatsApp JID (present in the non-business branch, from the on-WhatsApp check).

exists
boolean

Whether the number exists on WhatsApp (present in the non-business branch).

name
string

Contact/pushname (present in the non-business branch).

message
string

Explanatory message when the number is not a business profile.

description
string

Business description / about text.

email
string

Business contact email.

websites
string[]

Business website URLs (raw Baileys field).

website
string[]

Business website URLs.

address
string

Business physical address.

about
string

Business about text.

vertical
string

Business category/vertical.

profilehandle
string

Business profile handle.