Skip to main content
POST
Buscar contatos

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
where
object

Filtro com qualquer um dos campos _id, id, pushName, remoteJid.

Exemplo:

Resposta

Sucesso — corpo de resposta nativo do provedor.

id
string
obrigatório

Contact record id (cuid).

remoteJid
string
obrigatório

Contact JID.

instanceId
string
obrigatório

Owning instance id.

isGroup
boolean
obrigatório

True when remoteJid ends with @g.us.

isSaved
boolean
obrigatório

True when the contact has a pushName or profilePicUrl.

type
string
obrigatório

Derived category: "group", "contact" or "group_member".

pushName
string | null

Display/push name.

profilePicUrl
string | null

URL of the contact profile picture.

createdAt
string

ISO timestamp when created.

updatedAt
string

ISO timestamp of last update.