Pular para o conteúdo principal
GET
Obter informações do usuário
Retorna os dados de um contato: nomes, username, se a conta é Business (isBusiness) ou API Oficial (isOfficial), recado (status) e foto (avatar). O POST /api/v1/contacts/getuser devolve a mesma resposta, com os parâmetros no body.

Perfil WhatsApp Business

Quando o contato é uma conta business (app WhatsApp Business ou API Oficial), a resposta traz data.businessProfile com o perfil comercial público: descrição, e-mail, endereço, sites, localização, categorias, horário de atendimento, contas vinculadas do Instagram e do Facebook, serviços oferecidos e capa. O perfil vem por padrão. Ele custa uma consulta a mais ao WhatsApp (até 10 s); se você não precisa dele, desligue com business=false (query) no GET ou "business": false (body) no POST.
businessProfile só existe para contas business e quando a consulta dá certo. Em contato pessoal, com business=false ou se o WhatsApp não responder a tempo, a chave não vem — o resto do contato chega normalmente. Trate o campo como opcional.

Campos de businessProfile

string
Descrição do negócio
string
E-mail público
string
Endereço
string[]
Sites cadastrados (lista vazia quando não há). Algumas empresas colocam o link do Instagram aqui em vez de vincular a conta.
object | null
{ latitude, longitude } do local fixado no perfil, ou null
object[]
Categorias do negócio: { id, name }
object
object | null
Conta do Instagram vinculada: { handle, followers, url }, ou null
object | null
Página do Facebook vinculada: { id, name, likes, url }, ou null
object[]
Serviços e comodidades marcados no perfil, agrupados por categoria: { category, items: [{ id, name, offered }] }
string
Foto de capa. É um link assinado do CDN do WhatsApp que expira — baixe a imagem se precisar guardá-la.
string
catalog | shop | none
boolean
Se o carrinho de compras está ativo
string
smb (app WhatsApp Business) | ent (API / conta hospedada)
string
Nível de verificação informado pelo WhatsApp
string
Tipo de automação informado pelo WhatsApp
string
Data de cadastro da empresa em RFC 3339, ou vazio quando o WhatsApp não informa
string
O mesmo dado em texto, como o WhatsApp exibe

Autorizações

Authorization
string
header
obrigatório

API Key para autenticação. Formato: <API_KEY>

Parâmetros de caminho

phone
string
obrigatório

Parâmetros de consulta

sessionId
string
obrigatório
Minimum string length: 1
async
avatar
string
force
string
preview
string
business
string

Resposta

200

Resposta bem-sucedida