Newest first, with totals per status.
Your API key from the console (gw_live_…).
In: header
Query Parameters
Items per page, 1 to 250. Default 100.
1 <= value <= 250100The cursor the previous page answered, passed back unchanged, for the next page (newest first). Leave it out for the first page; a null cursor means there is no next page. Keep the same filters from page to page: a page never skips or repeats an item that arrives meanwhile.
length <= 200Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/whatsapp/api/v1/accounts"{ "object": "AccountList", "items": [ { "object": "Account", "id": "wa_Xk2pQ9rT4vW8yZ1a", "type": "WHATSAPP", "name": "Jane Doe", "created_at": "2026-10-25T10:00:00.000Z", "connection_params": { "im": { "phone_number": "33612345678" } }, "groups": [], "sources": [ { "id": "wa_Xk2pQ9rT4vW8yZ1a_MESSAGING", "status": "OK" } ], "gateway": { "status": "active", "reason": null, "detail": null, "connection": "open", "proxy": { "network_type": "residential", "country": "FR", "ip": "203.0.113.40", "city": "Lyon", "isp": "Example Telecom", "changed_at": "2026-10-25T10:00:05.000Z", "checked_at": "2026-10-31T09:30:00.000Z" }, "checkpoint": null, "lid": "123456789012345@lid", "linked_at": "2026-10-25T10:01:00.000Z", "last_open_at": "2026-10-31T09:30:00.000Z", "new_chat_quota": null, "new_chats_block": null } } ], "cursor": null, "total_count": 1, "status_counts": { "OK": 1, "CONNECTING": 0, "CREDENTIALS": 0, "STOPPED": 0 }}Link a WhatsApp number POST
Starts a link and answers once WhatsApp shows something (a few seconds): a QR to scan, or a pairing code with `pairing_phone_number`. Both are 201 `Checkpoint`. The QR rotates about every 20 s: read the current one from `GET /accounts/{id}` (`gateway.checkpoint`). When the phone accepts, the account goes `OK` (events `CREATION_SUCCESS`, `OK`). 503 `whatsapp-connecting` when WhatsApp did not answer: try again.
Change a number's proxy PATCH
A new `proxy`, `country` or `ip`: the number reconnects through it once its exit IP checks out. A number held by its proxy is let go.