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
Your instance ID. Available in the Z-API panel under Instances.
Your Z-API instance token.
Query Parameters
Used for pagination, specify the chat page you want to fetch
Specifies the number of chats returned per page
Response
200
Whether the chat is archived
Whether the chat is pinned
Contact phone number
Number of unread messages
Chat name (returns IDs for groups/broadcast lists)
Last interaction timestamp
0 or 1 indicating if chat is muted
Whether the chat is marked as spam
Whether it is a group
Chat annotations (available only for WhatsApp Business)