Skip to main content
POST
Search chats with filters

Authorizations

token
string
header
required

Body

application/json
operator
enum<string>
default:AND

Logical operator between filters

Available options:
AND,
OR
sort
string

Sort field (+/-field). E.g. -wa_lastMsgTimestamp

limit
integer

Full format: default 2000, keeping an explicit positive limit with no new cap. Compact format: default 100, maximum 200. Omitted, zero or negative uses the mode's default.

offset
integer
default:0

Number of records to skip (for pagination)

compact
boolean
default:false

Returns only the projection used in lists/sidebar: identity, names, preview, flags, unread, last message, labels, and essential lead fields. Does not return custom fields, full notes, or chatbot state.

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

Unread messages, with operator: >0 returns conversations with unread messages.

lead_awaitingReply
boolean

true: conversations in which the contact is awaiting a reply (awaiting you); false: those that are not. Conversations without a last message are not included in either.

wa_label
string

ID of the label applied to the chat. Use the value returned by /labels, not the label name.

wa_notes
string
lead_tags
string
lead_isTicketOpen
boolean
lead_assignedAttendant_id
string
lead_status
string

Use =value for explicit equality.

lead_tag
string

Returns chats that contain exactly this tag in lead_tags, without confusing partially matching names.

Response

200 - application/json

List of chats found

chats
object[]

Chats on the page. In compact mode, only the listing projection fields are populated.

totalChatsStats
object

Total chat counters

pagination
object