Skip to main content
GET

Request

string
required
Bearer olive_live_xxx or Bearer eyJ... (JWT)

Query Parameters

string
Filter by type: super_agent or sub_agent
string
Filter by status: active, suspended, terminated
string
Filter by parent agent (for sub-agents)
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

Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Query Parameters

agent_type
string

Filter by agent type (super_agent or sub_agent)

parent_agent_id
string

Filter by parent agent ID

limit
integer
default:50

Number of results to return

offset
integer
default:0

Offset for pagination

Response

OK

The response is of type object.