Skip to main content
GET
Get chats

Overview

This method is responsible for returning all chats.

Attributes

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)

405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

415

If you receive a 415 error, make sure to add the “Content-Type” header to your request, which in most cases is “application/json”.