API reference.
A REST API for contacts, conversations, messages, broadcasts and webhooks.
Getting started
Every request is made against the base URL /api/v1 and returns JSON. Authenticate with an API key using a Bearer token in the Authorization header — Authorization: Bearer <key>. Requests are rate-limited to roughly 120 requests per minute per key; exceed it and you'll receive a 429 response.
Endpoints
GET /api/v1/contacts
List contacts, with pagination and filtering.
POST /api/v1/contacts
Create a contact with a name, number and custom fields.
GET /api/v1/conversations
List conversations across your shared inbox.
POST /api/v1/messages
Send a message to a contact on your WhatsApp number.
GET /api/v1/broadcasts / POST /api/v1/broadcasts
List existing broadcasts, or create a new template campaign.
GET /api/v1/webhooks / POST /api/v1/webhooks
Manage webhooks for inbound messages and status events.
Build on Flixer
Grab an API key from your dashboard and make your first call in minutes.