Skip to main content
GET
/
v1
/
whatsapp
/
instances
Listar instâncias (WhatsApp)
curl --request GET \
  --url https://api.notifique.dev/v1/whatsapp/instances \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "<string>",
      "name": "<string>",
      "phoneNumber": "<string>",
      "status": "PENDING",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "total": 123,
    "page": 123,
    "limit": 123,
    "totalPages": 123
  }
}

Authorizations

Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Query Parameters

page
string
limit
string
status
enum<string>
Available options:
PENDING,
ACTIVE,
DISCONNECTED,
SUSPENDED,
CANCELLED

Response

Lista de instâncias e paginação.

success
boolean
Example:

true

data
object[]
pagination
object