Skip to navigation

List WhatsApp Business Accounts

View as MarkdownOpen in Claude

Returns the WhatsApp Business Accounts connected to the project. Each account owns WhatsApp numbers and message templates. Use a whatsapp_business_id from this list when creating or filtering message templates; use List WhatsApp numbers when you need a whatsapp:-prefixed sender address instead.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Numbers.

Learn more about API scopes.

Authentication

AuthorizationBasic

SignalWire Basic Authentication using Project ID and API Token.

The client sends HTTP requests with the Authorization header containing the word Basic followed by a space and a base64-encoded string of project_id:token. The project ID will be used as the username and the API token as the password.

Example:

Authorization: Basic base64(project_id:token)

Response

The request has succeeded.
datalist of objects
List of WhatsApp Business Accounts connected to the Space.

Errors

401
Unauthorized Error
500
Internal Server Error