Pular para o conteúdo principal
GET
/
api
/
v1
/
instances
Listar todas as instâncias
curl --request GET \
  --url https://6827d740d717.ngrok-free.app/api/v1/instances \
  --header 'Authorization: <api-key>'
[
  {
    "id": "inst_1234567890abcdef",
    "name": "Minha Instância WhatsApp",
    "phone": "+5511999999999",
    "age": "MORE_30",
    "status": "ACTIVE",
    "provider": "whatsapp-web",
    "createdAt": "2024-01-15T10:30:00Z",
    "updatedAt": "2024-01-15T10:30:00Z",
    "configs": {
      "minDelay": 3000,
      "maxDelay": 7000,
      "minJitter": 1000,
      "maxJitter": 3000,
      "dailyLimit": 50,
      "monthlyLimit": 1000,
      "workingHours": {
        "start": "08:00",
        "end": "18:00"
      },
      "workingDays": [
        1,
        2,
        3,
        4,
        5
      ],
      "timeout": 30000,
      "maxRetries": 3
    },
    "connectInstanceAt": "2024-01-15T10:30:00Z",
    "proxies": [
      {
        "id": "proxy_1234567890abcdef",
        "provider": "webshare",
        "type": "http",
        "createdAt": "2024-01-15T10:30:00Z"
      }
    ]
  }
]

Autorizações

​
Authorization
string
header
obrigatório

API Key de autenticação - usar ApiKey {sua-api-key}

Parâmetros de consulta

​
status
enum<string>

Filtrar por status

Opções disponíveis:
ACTIVE,
INACTIVE,
CREATED
​
provider
string

Filtrar por provedor

Exemplo:

"whatsapp-web"

​
age
enum<string>

Filtrar por idade

Opções disponíveis:
MORE_30,
LESS_30,
LESS_7
​
search
string

Buscar por nome

Exemplo:

"WhatsApp"

​
page
number

Página da paginação

Intervalo obrigatório: x >= 1
Exemplo:

1

​
limit
number

Limite por página

Intervalo obrigatório: x >= 1
Exemplo:

10

​
sortBy
enum<string>

Campo para ordenação

Opções disponíveis:
name,
createdAt,
updatedAt,
status
​
sortOrder
enum<string>

Direção da ordenação

Opções disponíveis:
asc,
desc

Resposta

200 - application/json

Lista de instâncias

​
id
string
obrigatório

ID único da instância

Exemplo:

"inst_1234567890abcdef"

​
name
string
obrigatório

Nome da instância

Exemplo:

"Minha Instância WhatsApp"

​
phone
string
obrigatório

Número de telefone

Exemplo:

"+5511999999999"

​
age
string
obrigatório

Idade da instância

Exemplo:

"MORE_30"

​
status
string
obrigatório

Status da instância

Exemplo:

"ACTIVE"

​
provider
string
obrigatório

Provedor da instância

Exemplo:

"whatsapp-web"

​
createdAt
string<date-time>
obrigatório

Data de criação

Exemplo:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
obrigatório

Data de atualização

Exemplo:

"2024-01-15T10:30:00Z"

​
configs
object

Configurações da instância

Exemplo:
{
  "minDelay": 3000,
  "maxDelay": 7000,
  "minJitter": 1000,
  "maxJitter": 3000,
  "dailyLimit": 50,
  "monthlyLimit": 1000,
  "workingHours": { "start": "08:00", "end": "18:00" },
  "workingDays": [1, 2, 3, 4, 5],
  "timeout": 30000,
  "maxRetries": 3
}
​
connectInstanceAt
string<date-time>

Data de conexão da instância

Exemplo:

"2024-01-15T10:30:00Z"

​
proxies
object[]

Lista de proxies associados