WhatsApp Businesses

List WhatsApp Business Accounts

Changed on

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.

get/api/messaging/whatsapp/businesses

Request

  • Base URL
    https://{Your_Space_Name}.signalwire.com
  • URL
    https://{Your_Space_Name}.signalwire.com/api/messaging/whatsapp/businesses
  • Auth
    HTTP basic

Response

The request has succeeded.

Example response

{
  "data": [
    {
      "business_name": "Acme, Inc.",
      "business_portfolio_id": "1234567890",
      "waba_id": "109876543210987",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ]
}

Changes

Some revisions have not been checked yet.