Agent Assignments
List eligible agents in the tenant
Returns the tenant's agents (role=AGENT, parent_id=tenant) with filter and pagination, so external systems can populate agent pickers via API key.
Authorization
ApiKeyAuth X-API-Key<token>
API key from your dashboard (Settings > API Keys)
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://loading/api/v1/agents/list" \ -H "Content-Type: application/json" \ -d '{ "page": 0, "limit": 20, "search": "priya" }'{
"success": true,
"data": {
"total": 0,
"page": 0,
"limit": 0,
"data": [
{
"id": "agt_abc123",
"name": "Priya Sharma",
"email": "priya@acme.com",
"status": "ACTIVE",
"role": "AGENT"
}
]
}
}{
"success": false,
"message": "to field is required"
}{
"success": false,
"message": "user not authenticated"
}{
"success": false,
"message": "forbidden"
}{
"success": false,
"message": "internal server error"
}