Skip to main content

​
List Agents

Retrieve a list of agents belonging to the authenticated user.
​
query
string
Search term to filter agents by name
​
query
integer
default:"30"
Number of agents to return per page (1-100)
curl -X GET "https://api.example.com/api/v1/agents?search=voice&page_size=20" \
  -H "X-API-Key: your-api-key-here"

​
Response

​
status
object
Response status information
​
code
integer
HTTP status code (200)
​
message
string
Status message
​
data
array
Array of agent objects
​
id
string
Agent ID (numeric or ElevenLabs agent ID)
​
name
string
Agent name
​
tags
array
Array of tag strings
​
conversation_config
object
Agent conversation configuration
​
platform_settings
object
Platform-specific settings
​
published
boolean
Whether the agent is published
​
published_at
string
ISO 8601 timestamp when agent was published
​
elevenlabs_agent_id
string
Associated ElevenLabs agent ID
​
version
integer
Agent version number
​
phone_numbers
array
Array of associated phone number objects
​
created_at
string
ISO 8601 creation timestamp
​
updated_at
string
ISO 8601 last update timestamp
​
total_count
integer
Total number of agents matching the query
​
has_more
boolean
Whether there are more results available
{
  "status": {
    "code": 200,
    "message": "Success"
  },
  "data": [
    {
      "id": "123",
      "name": "Customer Support Agent",
      "tags": ["support", "voice"],
      "conversation_config": {
        "temperature": 0.7,
        "model": "gpt-4"
      },
      "platform_settings": {},
      "published": true,
      "published_at": "2024-01-15T10:30:00Z",
      "elevenlabs_agent_id": "agent_abc123",
      "version": 1,
      "phone_numbers": [
        {
          "id": 1,
          "phone_number": "+1234567890",
          "provider": "elevenlabs",
          "elevenlabs_phone_number_id": "phone_xyz"
        }
      ],
      "user_id": 1,
      "user_email": "[email protected]",
      "created_at": "2024-01-10T08:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"
    }
  ],
  "total_count": 1,
  "has_more": false
}

​
Error Responses

​
401
object
Unauthorized - Invalid or missing authentication
​
500
object
Internal server error