Connection history

This page documents the connection history, an auditable timeline of when each WhatsApp number was linked (connected) and unlinked (disconnected) from an instance. Use it to follow and confirm which number was connected at each moment, handy when reviewing a billed period with transparency, with the record in hand.

Query the history

GET /api/account/connections?number=<jid>&instance=<id>&from=<rfc3339>&to=<rfc3339>&limit=<n> Returns the account’s link and unlink events, most recent first. Authenticate with the account TokenAccount, or with the global token passing ?account=<account-name>. All filters are optional: with none, you get the account’s most recent events.

string

Filters by a specific number. Use the exact JID, e.g. 5511999998888@s.whatsapp.net.

string

Filters by a specific instance. Use the instanceId that appears in the events themselves.

string

Start of the window, in RFC3339. Without it, there is no lower bound.

string

End of the window, in RFC3339. Without it, there is no upper bound.

integer

Maximum number of events to return. Default 200. Values outside the 1 to 1000 range also use 200.

string

Account name. Required only when you use the global token.

curl "https://ryzeapi.cloud/api/account/connections?number=5511999998888@s.whatsapp.net&limit=50" \
  -H "token: $Token_Account"

const params = new URLSearchParams({
  number: "5511999998888@s.whatsapp.net",
  limit: "50"
});

await fetch(`https://ryzeapi.cloud/api/account/connections?${params}`, {
  headers: { "token": process.env.Token_Account }
});

import os, requests

requests.get(
    "https://ryzeapi.cloud/api/account/connections",
    headers={"token": os.environ["Token_Account"]},
    params={"number": "5511999998888@s.whatsapp.net", "limit": 50}
)

200 OK

{
  "events": [
    {
      "instanceId": "9f1c2b3a-7d4e-4a1b-9c2d-3e4f5a6b7c8d",
      "instanceName": "client-acme",
      "numberJid": "5511999998888@s.whatsapp.net",
      "event": "unlinked",
      "at": "2026-08-20T09:05:00Z"
    },
    {
      "instanceId": "9f1c2b3a-7d4e-4a1b-9c2d-3e4f5a6b7c8d",
      "instanceName": "client-acme",
      "numberJid": "5511999998888@s.whatsapp.net",
      "event": "linked",
      "at": "2026-08-01T12:30:00Z"
    }
  ]
}

Response fields

array

The connection events, most recent first. A deleted instance keeps its events, with the name and number it had, because the record survives deletion.

Show fields of each event

string

Instance identifier. Use this value in the instance filter.

string

Instance name at the time of the event.

string

The WhatsApp number (JID) involved in the event.

string

linked when the number was linked (connection) or unlinked when it was unlinked (disconnection).

string

When the event happened, in RFC3339 (UTC).

Usage statement

The itemized invoice for the period, instance by instance.

Enterprise webhooks

React to each state change by event.

Getting started

Billing

Audit

Reference

Connection history

Query the history

Response fields

Next

Usage statement

Enterprise webhooks

​Query the history

​Response fields

​Next

Usage statement

Enterprise webhooks

Query the history

Response fields

Next