API Reference
The Loopwave REST API lets your own code send WhatsApp messages, read chats, and manage contacts, tickets, and broadcasts. Combined with webhooks, it’s everything you need to integrate Loopwave with any system you run.
Create an API key and authenticate your requests.
Quickstart→Send your first message in a single curl command.
Endpoints→Every /api/v1 endpoint with curl and JSON examples.
Per-key limits and the headers to watch.
Webhooks→Receive events to complement the API.
Base URL
All endpoints live under the /api/v1 path of your Loopwave deployment:
https://YOUR_DOMAIN/api/v1For local development that’s typically http://localhost:4000/api/v1.
How it works
- Authenticate every request with an API key (
Authorization: Bearer lw_live_...orX-API-Key: lw_live_...). - Scopes limit what each key can do — for example a key with only
messages:writecan send messages but not read contacts. - Reads always work, even on an expired license. Writes (sending, creating) are blocked when a license is expired or revoked in enforce mode.
- Responses are JSON. List endpoints wrap results in a
dataarray; errors return{ "error": "...", "message": "..." }.
What you can do
| Area | Capabilities |
|---|---|
| Messages | Send a WhatsApp message from a connected number. |
| Chats | List chats and read message threads. |
| Contacts | List and create CRM contacts. |
| Tickets | List and create support tickets. |
| Broadcasts | Create and queue a paced broadcast. |
The Endpoints page documents every /api/v1 route —
method, path, scope, parameters, a curl example, and a sample JSON response —
kept in step with Loopwave’s OpenAPI spec (api-reference/openapi.json).