Skip to main content

Overview

Retrieve all WhatsApp Business phone numbers that have been integrated into your workspace. This endpoint returns the list of connected numbers along with their current status and associated configuration.

Prerequisites

  • Bearer Token authentication

Request

string
required
Bearer token for authenticated workspace access.

Response

boolean
Indicates whether the request completed successfully.
integer
HTTP status code returned by the API.
string
Human-readable success message.
array
List of WhatsApp Business numbers connected to the workspace.
string
Unique identifier of the integration.
string
WhatsApp Business Phone Number ID.
string
Connected WhatsApp Business phone number.
string
Display name configured in the WhatsApp Business account.
string
Current integration status.
string
ID of the WhatsApp Agent currently assigned to this number, if any.
string
Timestamp when the integration was created.

Error Handling

This endpoint only returns WhatsApp numbers that belong to the authenticated workspace.
Use the returned phoneNumberId to:
  • Assign a WhatsApp Agent to the number.
  • Update the integration.
  • Remove the integration.
  • Retrieve available message templates for that number.