Search groups
Groups
Search groups
Returns all groups from the instance
GET
Search groups
Overview
This method is responsible for returning all groups.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 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