Pular para o conteúdo principal
GET
/
instances
Listando instâncias
curl --request GET \
  --url https://api.z-api.io/instances \
  --header 'Client-Token: <api-key>'

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

Método utilizado para listar todas as instâncias criadas.
Para utilizar os endpoints de Partner, informe o Token de Parceiro no campo Authorization, no formato: Bearer <Partner-Token>Não é necessário enviar o Client-Token nessas requisições.

​
Atributos

​
Query Parameters

​
page
integer
obrigatório
Página que quer buscar
​
pageSize
integer
obrigatório
Tamanho do retorno por página
​
query
string
Busca pelo nome e ID da instância
​
middleware
string
Tipo da instância: web ou mobile

​
Exemplos de requisições

​
Listar por nome ou ID da instância

https://api.z-api.io/instances?page=1&pageSize=15&query=NOME_OU_INSTANCEID

​
Listar por tipo (web ou mobile)

https://api.z-api.io/instances?page=1&pageSize=15&middleware=web

​
Listar por tipo (web ou mobile) + nome ou ID da instância

https://api.z-api.io/instances?page=1&pageSize=15&middleware=web&query=NOME_OU_INSTANCEID

​
Response

​
200

{
  "total": 1,
  "totalPage": 1,
  "pageSize": 1,
  "page": 1,
  "content": [
    {
      "token": "",
      "tenant": "",
      "created": "",
      "due": 1648565999675,
      "paymentStatus": "",
      "deliveryCallbackUrl": "",
      "phoneConnected": false,
      "whatsappConnected": false,
      "middleware": "web",
      "name": "",
      "id": ""
    }
  ]
}

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