Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
communities
List communities
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/communities \
  --header 'Client-Token: <api-key>'
{
  "name": "<string>",
  "id": "<string>"
}

​
Overview

This method is responsible for returning all communities you are part of.

​
Attributes

​
instanceId
string
required
Your instance ID. Available in the Z-API panel under Instances.
​
token
string
required
Your Z-API instance token.

​
Query Parameters

​
page
integer
Used for pagination, specify the page you want to fetch
​
pageSize
integer
Specifies the number of results returned per page

​
Response

​
200

​
name
string
Community name
​
id
string
Community ID
[
  {
    "name": "My first Community",
    "id": "98372465382764532938"
  }
]

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