Get WhatsApp Connection Status
Check whether a WhatsApp Business Account is connected to your workspace.
GET
Your role needs the workspace:view permission. Otherwise the request fails with 403 {"error": "Insufficient permissions", "requiredPermission": "workspace:view"}.
Headers
x-workspace-idstringrequiredWorkspace identifier for the API.
Response Fields
metaWhatsAppobjectThe workspace's WhatsApp connection. Every field except isConnected is null when nothing is connected.
Errors
| Status | Body | When |
|---|---|---|
403 | {"error": "Insufficient permissions"} | Your role lacks workspace:view |
404 | {"message": "Workspace not found"} | The workspace doesn't exist |
500 | {"message": "Error fetching Meta WhatsApp workspace status"} | Unexpected server error |
Connected
{
"metaWhatsApp": {
"isConnected": true,
"wabaId": "123456789012345",
"wabaName": "My Business WhatsApp",
"businessId": "987654321098765",
"businessName": "My Company Inc.",
"connectedAt": "2026-10-01T08:45:00.000Z",
"connectedBy": "b5b5b5b5b5b5b5b5b5b5b5b5"
}
}Not connected
{
"metaWhatsApp": {
"isConnected": false,
"wabaId": null,
"wabaName": null,
"businessId": null,
"businessName": null,
"connectedAt": null,
"connectedBy": null
}
}Last updated on