> ## 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.

# Listando instâncias

> Lista todas as instâncias criadas pelo parceiro integrador

## Conceituação

Método utilizado para listar todas as instâncias criadas.

<Warning>
  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.
</Warning>

***

## Atributos

### Query Parameters

<ParamField query="page" type="integer" required>
  Página que quer buscar
</ParamField>

<ParamField query="pageSize" type="integer" required>
  Tamanho do retorno por página
</ParamField>

<ParamField query="query" type="string">
  Busca pelo nome e ID da instância
</ParamField>

<ParamField query="middleware" type="string">
  Tipo da instância: `web` ou `mobile`
</ParamField>

***

## Exemplos de requisições

### Listar por nome ou ID da instância

```bash theme={"theme":{"light":"github-light","dark":"poimandres"}}
https://api.z-api.io/instances?page=1&pageSize=15&query=NOME_OU_INSTANCEID
```

### Listar por tipo (web ou mobile)

```bash theme={"theme":{"light":"github-light","dark":"poimandres"}}
https://api.z-api.io/instances?page=1&pageSize=15&middleware=web
```

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

```bash theme={"theme":{"light":"github-light","dark":"poimandres"}}
https://api.z-api.io/instances?page=1&pageSize=15&middleware=web&query=NOME_OU_INSTANCEID
```

## Response

### 200

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "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".