Skip to main content
GET
/
api
/
agents
List Agents
curl --request GET \
  --url https://api.example.com/api/agents \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-Organization-Id: <x-organization-id>'
{
  "success": true,
  "data": [
    {
      "agent_id": "agent_a1b2c3d4e5f6",
      "agent_name": "Sales Rep",
      "language": "EN",
      "stt_provider": "deepgram",
      "tts_provider": "elevenlabs",
      "llm_provider": "openai",
      "llm_model": "gpt-4o",
      "recording_enabled": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6ImFnZW50X3h5ejEyMyIsInBhZ2UiOjJ9",
    "has_more": true,
    "page_size": 50,
    "total_count": 127
  }
}
Retrieve a paginated list of all agents configured for your organization.

​
Headers

​
X-API-Key
string
required
Your API key for authentication.
​
X-Organization-Id
string
required
The organization ID.

​
Query Parameters

​
limit
integer
default:"50"
Number of results per page (1-100).
​
cursor
string
Pagination cursor from previous response for fetching the next page.

​
Permissions

  • agents:read (all roles)

​
Response

​
success
boolean
Indicates if the request was successful.
​
data
array
List of agent summary objects.
​
pagination
object
Pagination metadata.
{
  "success": true,
  "data": [
    {
      "agent_id": "agent_a1b2c3d4e5f6",
      "agent_name": "Sales Rep",
      "language": "EN",
      "stt_provider": "deepgram",
      "tts_provider": "elevenlabs",
      "llm_provider": "openai",
      "llm_model": "gpt-4o",
      "recording_enabled": true,
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-20T14:45:00Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJpZCI6ImFnZW50X3h5ejEyMyIsInBhZ2UiOjJ9",
    "has_more": true,
    "page_size": 50,
    "total_count": 127
  }
}