Skip to main content
POST
Obter perfil do contato

Autorizações

apikey
string
header
obrigatório

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

Parâmetros de caminho

instance
string
obrigatório

O nome de exibição do número no painel do Pilot Status.

Corpo

application/json
number
string
obrigatório

Número de telefone ou JID cujo perfil deve ser obtido.

Exemplo:

"5511999999999"

Resposta

Sucesso — corpo de resposta nativo do provedor.

wuid
string
obrigatório

WhatsApp JID of the profile.

isBusiness
boolean
obrigatório

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).