Agents
List Agents
List all agents with filtering and pagination
GET
Request
string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)Query Parameters
string
Filter by type:
super_agent or sub_agentstring
Filter by status:
active, suspended, terminatedstring
Filter by parent agent (for sub-agents)
string
Search by name, business name, or phone
integer
default:"50"
Results per page (max 100)
integer
default:"0"
Pagination offset
Response
array
Array of agent objects
integer
Total matching agents
Examples
Common Filters
Errors
Authorizations
API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'
Query Parameters
Filter by agent type (super_agent or sub_agent)
Filter by parent agent ID
Number of results to return
Offset for pagination
Response
OK
The response is of type object.