WhatsApp API Platform
Agent Assignments

List customers currently assigned to an agent

GET
/api/v1/agents/{agentId}/customers

Paginated list. The agent must belong to your tenant.

Authorization

ApiKeyAuth
X-API-Key<token>

API key from your dashboard (Settings > API Keys)

In: header

Path Parameters

agentId*string

Agent id (User cuid2)

Query Parameters

page?integer

Page number, 0-indexed (first page is 0).

Default0
Range0 <= value
limit?integer
Default20
Range1 <= value <= 100

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://loading/api/v1/agents/string/customers"
{
  "success": true,
  "data": {
    "total": 0,
    "page": 0,
    "limit": 0,
    "data": [
      {
        "id": "cus_abc123",
        "identifier": "919876543210",
        "name": "string",
        "waba_id": "string",
        "conversation_status": "OPEN"
      }
    ]
  }
}
{
  "success": false,
  "message": "user not authenticated"
}
{
  "success": false,
  "message": "forbidden"
}
{
  "success": false,
  "message": "Agent not found"
}
{
  "success": false,
  "message": "internal server error"
}