Skip to main content
GET
Buscar conversa por JID

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.

Resposta

object | null

Sucesso — corpo de resposta nativo do provedor.

The stored Chat record for the given remoteJid, or null when no chat exists.

id
string
obrigatório

Chat record id (cuid).

remoteJid
string
obrigatório

Chat JID.

instanceId
string
obrigatório

Owning instance id.

unreadMessages
integer
obrigatório

Count of unread messages in the chat.

name
string | null

Chat/group name, when known.

labels
string[] | null

Label ids applied to the chat.

createdAt
string

ISO timestamp when the chat was created.

updatedAt
string

ISO timestamp of last update.