Skip to main content
POST
Busca chats com filtros

Autorizações

token
string
header
obrigatório

Corpo

application/json
operator
enum<string>
padrão:AND

Operador lógico entre os filtros

Opções disponíveis:
AND,
OR
sort
string

Campo para ordenação (+/-campo). Ex -wa_lastMsgTimestamp

limit
integer

Formato completo: padrão 2000, preservando limit positivo explícito sem novo teto. Formato compacto: padrão 100, máximo 200. Omitido, zero ou negativo usa o padrão do modo.

offset
integer
padrão:0

Número de registros a pular (para paginação)

compact
boolean
padrão:false

Retorna somente a projeção usada em listas/sidebar: identidade, nomes, preview, flags, unread, última mensagem, labels e campos essenciais do lead. Não retorna campos customizados, notas completas nem estado do chatbot.

wa_fastid
string
wa_chatid
string
wa_archived
boolean
wa_contactName
string
wa_name
string
name
string
wa_isBlocked
boolean
wa_isGroup
boolean
wa_isGroup_admin
boolean
wa_isGroup_announce
boolean
wa_isGroup_member
boolean
wa_isPinned
boolean
wa_unreadCount
string

Mensagens não lidas, com operador: >0 traz as conversas com não lidas.

lead_awaitingReply
boolean

true: conversas em que o contato espera resposta (aguardando você); false: as que não esperam. Conversa sem última mensagem não entra em nenhum dos dois.

wa_label
string

ID da label aplicada ao chat. Use o valor retornado por /labels, não o nome da etiqueta.

wa_notes
string
lead_tags
string
lead_isTicketOpen
boolean
lead_assignedAttendant_id
string
lead_status
string

Use =valor para igualdade explícita.

lead_tag
string

Retorna chats que contenham exatamente esta tag em lead_tags, sem confundir nomes parcialmente iguais.

Resposta

200 - application/json

Lista de chats encontrados

chats
object[]

Chats da página. No modo compacto, somente os campos da projeção de listagem são preenchidos.

totalChatsStats
object

Contadores totais de chats

pagination
object