Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
catalogs
/
collection
Listar coleções
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/catalogs/collection \
  --header 'Client-Token: <api-key>'
{
  "nextCursor": "<string>",
  "collections": [
    {}
  ]
}

Documentation Index

Fetch the complete documentation index at: https://developer.z-api.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conceituação

Este método é responsável por listar todas as coleções cadastradas no catálogo do WhatsApp Business.

​
Atributos

​
instanceId
string
obrigatório
ID da sua instância. Disponível no painel Z-API em Instâncias.
​
token
string
obrigatório
Token da sua instância Z-API.

​
Query Parameters

​
nextCursor
string
Cursor para paginação dos resultados

​
Response

​
200

​
nextCursor
string
Cursor para a próxima página de resultados
​
collections
array
Lista de coleções
{
  "nextCursor": "AQHRi...",
  "collections": [
    {
      "id": "1072603710847740",
      "name": "Nome da coleção",
      "status": "APPROVED"
    }
  ]
}

​
405

Neste caso certifique que esteja enviando corretamente a especificação do método, ou seja verifique se você enviou o POST ou GET conforme especificado no início deste tópico.

​
415

Caso você receba um erro 415, certifique de adicionar na headers da requisição o “Content-Type” do objeto que você está enviando, em sua grande maioria “application/json”.