Skip to main content
GET
Search groups

Overview

This method is responsible for returning all groups.

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 group page you want to fetch
integer
required
Specifies the number of groups returned per page

Response

200

boolean
Whether it is a group or not
string
Chat name
string
Group ID/Phone
string
Number of unread messages in the chat
string
Timestamp with the date and time of the last interaction with the chat
string
0 or 1 indicating if you muted this chat or not
boolean
Whether the chat is archived
boolean
Whether the chat is pinned

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”.