Get chats
Chats
Get chats
Returns all chats from the instance
GET
Get chats
Overview
This method is responsible for returning all chats.Attributes
Header
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Query Parameters
integer
required
Used for pagination, specify the chat page you want to fetch
integer
required
Specifies the number of chats returned per page
Response
200
boolean
Whether the chat is archived
boolean
Whether the chat is pinned
string
Contact phone number
string
Number of unread messages
string
Chat name (returns IDs for groups/broadcast lists)
string
Last interaction timestamp
string
0 or 1 indicating if chat is muted
boolean
Whether the chat is marked as spam
boolean
Whether it is a group
object
Chat annotations (available only for WhatsApp Business)