Public API Overview

Quick Overview

The WaaPY Public API lets you send messages, manage contacts, labels, queues, tickets, and connections programmatically. All requests use a workspace API key as a Bearer token and go through rate limiting and monthly quota checks.

Base URL

Use your WaaPY instance base URL with the API path prefix. The public API is available at:

<v1_base_url>/v1/

Replace <v1_base_url> with the base URL for your environment (for example https://api.your-waapy-instance.com).

Authentication

All endpoints require authentication via a Bearer token. You must include the Authorization header with your workspace API key:

Authorization: Bearer wckey_your_api_key_here

The API key is created per workspace and can be found in Settings > General > API Keys. Only workspace admins can view the API key. Keep it secure and do not share it in public places.

For more details, see Authentication.

Available Endpoints

The Public API provides the following groups of endpoints:

Group	Purpose
Messages	Send messages and react to messages.
Contacts	Create, read, update, delete, and bulk delete contacts.
Labels	List workspace labels.
Queues	List workspace queues.
Connections	List workspace connections.
Tickets	List, view, and manage tickets including labels, queue assignment, transfer, and status changes.
Errors	Common error responses and how to resolve them.
OpenAPI	Access the OpenAPI specification and in-app API docs.

Rate Limits and Quota

• All Public API requests go through a rate limiter.
• Each workspace has a monthly request quota for the Public API. If the quota is exceeded, requests return 429 with error code ERR_PUBLIC_API_LIMIT_REACHED.
• Usage is tracked per workspace on a monthly basis.

Security Notes

• Treat your API key as a secret. If it is compromised, rotate it from Settings > General > API Keys.
• The API key is only visible to workspace admins.
• Always use HTTPS when making requests.
• Do not log API keys or include them in client-side code.