Skip to main content

Overview

Retrieve a list of all WhatsApp AI Agents configured in your workspace. This endpoint is useful for displaying agents, selecting an agent for editing, or managing your WhatsApp automations.

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 Agents available in the workspace.
string
Unique identifier of the WhatsApp Agent.
string
Display name of the WhatsApp Agent.
string
WhatsApp Business Phone Number assigned to the agent.
string
Current status of the WhatsApp Agent.
string
Timestamp when the agent was created.

Error Handling

This endpoint returns all WhatsApp Agents created within your authenticated workspace.
Use the returned Agent ID with:
  • GET /api/whatsapp/get-whatsapp-agent/{agentId} to retrieve a specific agent.
  • PUT /api/whatsapp/update-whatsapp-agent/{agentId} to update an agent.
  • DELETE /api/whatsapp/delete-whatsapp-agent/{agentId} to remove an agent.