Skip to main content
POST
Get contact 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 whose profile to fetch.

Example:

"5511999999999"

Response

Success — provider-native response body.

wuid
string
required

WhatsApp JID of the profile.

isBusiness
boolean
required

Whether the profile is a WhatsApp Business account.

name
string | null

Display/push name of the contact.

numberExists
boolean | null

Whether the number exists on WhatsApp.

picture
string | null

Profile picture URL, or null when hidden/not set.

status
string | null

The contact's status/about text (or connection status for own profile).

email
string | null

Business email (only for business profiles).

description
string | null

Business description (only for business profiles).

website
string | null

First business website URL (only for business profiles).