Skip to main content
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
List collections
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection \
  --header 'Client-Token: <api-key>'
{
  "nextCursor": "<string>",
  "collections": [
    {}
  ]
}

​
Overview

This method is responsible for listing all collections registered in the WhatsApp Business catalog.

​
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

​
nextCursor
string
Cursor for result pagination

​
Response

​
200

​
nextCursor
string
Cursor for the next page of results
​
collections
array
List of collections
{
  "nextCursor": "AQHRi...",
  "collections": [
    {
      "id": "1072603710847740",
      "name": "Nome da coleção",
      "status": "APPROVED"
    }
  ]
}

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