Referência da APIInstancias
Lista as instancias do projeto
Lista todas as instancias do Projeto da API key, no modo (teste ou producao) correspondente a key usada — uma key de teste so enxerga instancias de teste e vice-versa. Retorna um array (vazio se nao houver nenhuma), cada item no mesmo formato de GET /v1/instances/{id}, incluindo o status atual e, quando ja pareada, phoneNumber e jid. Sem paginacao.
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/instances"[
{
"id": "cm5x8a9k20001abc123def456",
"projectId": "cm5x000proj0001xyz",
"name": "minha-instancia",
"status": "CONNECTED",
"phoneNumber": "5511999999999",
"jid": "5511999999999@s.whatsapp.net",
"createdAt": "2026-05-30T12:00:00Z",
"updatedAt": "2026-05-30T12:05:00Z"
}
]{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}