Base URL
http://localhost:3000. With APP_BASE_PATH=/gowa, every route moves under /gowa except /health.
Authentication
WhenAPP_BASIC_AUTH is set, every route requires HTTP Basic Auth, except /health, /statics/*, the Chatwoot webhook and the MCP OAuth endpoints. See Authentication.
Device selection
Most routes act on one WhatsApp device. Choose it with theX-Device-Id header (slot ID or JID), or the device_id query parameter. When the server has exactly one device you may omit it; with more, it is required.
See Multi-device.
Endpoint groups
The endpoint pages in this tab are generated from GOWA’s OpenAPI specification. The authoritative contract is
docs/openapi.yaml in the server repository. This site uses a synchronized copy in openapi.yml, including /send/interactive. The interactive guide records its current limits.
Requests
- JSON bodies:
Content-Type: application/json. - File uploads:
multipart/form-data. - Phone numbers: digits with country code (
628123456789) or a full JID (...@s.whatsapp.net,...@g.us).
Responses
code is SUCCESS or an error code; results holds the data. See Errors.
Example
Contact names
GET /user/my/contacts returns a preferred display name for each contact. On GOWA main after v9.9.0, call GET /user/my/contacts/detailed to get the stored full_name, first_name, push_name, and business_name as separate fields. GOWA omits empty names and includes lid on a phone-number JID when the device has a mapping. The results contain person contacts from the selected device, sorted by jid.
Other interfaces
- WebSocket at
/wsfor live dashboard events. - MCP at
/mcpfor AI agents (MCP server). - Webhooks pushed to your URLs (Webhooks).
