Pular para o conteúdo principal
GET
/
instances
/
{instanceId}
/
token
/
{token}
/
communities
Listar comunidades
curl --request GET \
  --url https://api.z-api.io/instances/{instanceId}/token/{token}/communities \
  --header 'Client-Token: <api-key>'
{
  "name": "<string>",
  "id": "<string>"
}

​
Conceituação

Este método é responsável por retornar todas as comunidades que você faz parte.

​
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

​
page
integer
Utilizado para paginação, informe a página que quer buscar
​
pageSize
integer
Especifica o tamanho do retorno por página

​
Response

​
200

​
name
string
Nome da comunidade
​
id
string
ID da comunidade
[
  {
    "name": "Minha primeira Comunidade",
    "id": "98372465382764532938"
  }
]

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