List all agents with filtering and pagination
Bearer olive_live_xxx or Bearer eyJ... (JWT)super_agent or sub_agentactive, suspended, terminated| Use Case | Query |
|---|---|
| All super-agents | ?type=super_agent |
| Active sub-agents | ?type=sub_agent&status=active |
| My sub-agents | ?parent_agent_id={my_agent_id} |
| Search by name | ?search=John |
| Status | Code | Description |
|---|---|---|
| 401 | UNAUTHORIZED | Invalid API key |
| 403 | FORBIDDEN | Insufficient permissions |
| 500 | INTERNAL_ERROR | Server error |
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Filter by agent type (super_agent or sub_agent)
Filter by parent agent ID
Number of results to return
Offset for pagination
OK
The response is of type object.