Agents

List agents

Retrieve paginated list of AI agents, optionally filtered by campaign

get/api/v1/agents

Request

  • Base URL: http://localhost:8080
  • URL: http://localhost:8080/api/v1/agents
  • Auth: bearerAuth (a scheme the document does not define)

Query parameters

pageinteger
limitinteger
campaignIdstring uuid

Filter agents by campaign ID

phoneCapability'outbound_call' | 'outbound_whatsapp' | 'inbound_whatsapp' | 'outbound_sms'

Filter agents to those with at least one active phone with this capability

searchstring

Search agents by name (case-insensitive)

Response

Paginated list of agents

successtrue required

Example response

{
  "data": [
    {
      "name": "Sales Agent Q1"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.