Skip to main content
GET
/
whatsapp
/
instances
Listar instâncias WhatsApp
curl --request GET \
  --url http://localhost:3000/whatsapp/instances \
  --header 'Authorization: Bearer <token>'
[
  {
    "tenant": {
      "name": "<string>",
      "slug": "<string>",
      "apiKey": "<string>",
      "id": "692c2bb1-766b-4bd3-a276-3790ba67b6a0",
      "createdAt": "2026-02-08T22:34:29.553Z",
      "updatedAt": "2026-02-08T22:34:29.554Z",
      "whatsappRateLimit": {
        "max": 123,
        "durationMs": 123
      },
      "webhookSourceLabel": "<string>"
    },
    "account": {
      "tenant": {
        "name": "<string>",
        "slug": "<string>",
        "apiKey": "<string>",
        "id": "692c2bb1-766b-4bd3-a276-3790ba67b6a0",
        "createdAt": "2026-02-08T22:34:29.553Z",
        "updatedAt": "2026-02-08T22:34:29.554Z",
        "whatsappRateLimit": {
          "max": 123,
          "durationMs": 123
        },
        "webhookSourceLabel": "<string>"
      },
      "user": {
        "tenant": {
          "name": "<string>",
          "slug": "<string>",
          "apiKey": "<string>",
          "id": "692c2bb1-766b-4bd3-a276-3790ba67b6a0",
          "createdAt": "2026-02-08T22:34:29.553Z",
          "updatedAt": "2026-02-08T22:34:29.554Z",
          "whatsappRateLimit": {
            "max": 123,
            "durationMs": 123
          },
          "webhookSourceLabel": "<string>"
        },
        "auth0Sub": "<string>",
        "role": "OPERATOR",
        "isActive": true,
        "id": "60bc9d16-1814-4acc-ac59-07f062ed7116",
        "createdAt": "2026-02-08T22:34:29.554Z",
        "updatedAt": "2026-02-08T22:34:29.554Z",
        "account": "<unknown>",
        "email": "<string>"
      },
      "name": "<string>",
      "id": "9e572381-cafa-4f40-8c79-45e6d616b767",
      "createdAt": "2026-02-08T22:34:29.554Z",
      "updatedAt": "2026-02-08T22:34:29.554Z"
    },
    "provider": "evolution",
    "instanceName": "<string>",
    "isDefault": false,
    "status": "CONNECTING",
    "id": "92463263-6f8e-4c72-8d98-e0c33f3aa490",
    "createdAt": "2026-02-08T22:34:29.553Z",
    "updatedAt": "2026-02-08T22:34:29.553Z",
    "deletedAt": "2023-11-07T05:31:56Z",
    "lastError": "<string>",
    "metadata": {}
  }
]

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

accountId
string

Response

200 - application/json
tenant
object
required
account
object
required
provider
string
default:evolution
required
instanceName
string
required
isDefault
object
required
status
enum<string>
default:CONNECTING
required
Available options:
CONNECTING,
CONNECTED,
DISCONNECTED,
INACTIVE,
ERROR
id
string
default:92463263-6f8e-4c72-8d98-e0c33f3aa490
required
createdAt
string<date-time>
default:2026-02-08T22:34:29.553Z
required
updatedAt
string<date-time>
default:2026-02-08T22:34:29.553Z
required
deletedAt
string<date-time> | null
lastError
string | null
metadata
object