Listar instâncias

Amb. de Desenv.

http://localhost:3000

GET

/instances

Lista todas as instâncias do cliente autenticado.

Cada item já inclui os webhooks cadastrados para a instância, com eventType, url e enabled.
Se a instância não tiver webhook cadastrado, o campo webhooks vem como [].

Requisição

Authorization

Adicionar parâmetro em header

x-api-key

Exemplo:

x-api-key: ********************

Parâmetros Header

Respostas

🟢200OK

application/json

Lista de instâncias do cliente autenticado com os webhooks cadastrados.

Body

🟠401Não Autorizado

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'http://localhost:3000/instances' \
--header 'x-api-key: <api-key>'

Response Example

200 - Lista mista

{
    "instances": [
        {
            "instanceId": "018f47ac-7a5b-7cc2-9f6d-111111111111",
            "name": "Atendimento Principal",
            "status": "disconnected",
            "connectionType": null,
            "phoneNumber": null,
            "webhooks": [
                {
                    "eventType": "message.sent",
                    "url": "https://meusistema.com.br/webhooks/wayapi",
                    "enabled": true
                }
            ]
        },
        {
            "instanceId": "018f47ac-7a5b-7cc2-9f6d-222222222222",
            "name": "Financeiro",
            "status": "connected",
            "connectionType": "code",
            "phoneNumber": "5511999999999",
            "webhooks": []
        },
        {
            "instanceId": "018f47ac-7a5b-7cc2-9f6d-333333333333",
            "name": "Suporte",
            "status": "connecting",
            "connectionType": "qrcode",
            "phoneNumber": "5511888888888",
            "webhooks": [
                {
                    "eventType": "message.sent",
                    "url": "https://meusistema.com.br/webhooks/suporte/sent",
                    "enabled": true
                },
                {
                    "eventType": "message.received",
                    "url": "https://meusistema.com.br/webhooks/suporte/received",
                    "enabled": false
                }
            ]
        }
    ]
}

Modificado em 2026-04-17 20:31:44