Skip to main content
GET
/
api
/
agents
List Agents
curl --request GET \
  --url https://api.getello.ai/api/agents \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
[
  {
    "filters": {
      "status": true,
      "type": "outbound"
    }
  }
]
'
{
  "status": 200,
  "message": "Agents retrieved successfully",
  "data": [
    {
      "id": "683715217c8e5fe1361c6faa",
      "name": "My Outbound Agent",
      "type": "outbound",
      "createdAt": "2025-05-28T13:52:33.951000",
      "voiceEngine": "elevenlabs",
      "phoneNumber": null,
      "status": true
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 100,
    "total": 2,
    "totalPages": 1,
    "hasNextPage": false,
    "hasPrevPage": false
  }
}

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer
default:10

Number of agents per page

Required range: 1 <= x <= 100
Example:

10

​
page
integer
default:1

Page number

Required range: x >= 1
Example:

1

​
category
string

Filter by agent category

Example:

"sales"

​
search
string

Search in name or description

Example:

"outbound"

​
sort_field
string
default:createdAt

Field to sort by

Example:

"createdAt"

​
sort_order
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
Example:

"desc"

​
startDate
string<date-time>

Filter agents created on or after this date (ISO 8601)

Example:

"2025-05-01T00:00:00.000Z"

​
endDate
string<date-time>

Filter agents created before this date (ISO 8601)

Example:

"2025-05-31T23:59:59.999Z"

Body

application/json

Advanced filter groups (AND between groups, OR within group)

​
filters
object
required
Example:
[
  {
    "filters": { "status": true, "type": "outbound" }
  }
]

Response

Agents retrieved successfully

​
status
integer
Example:

200

​
message
string
Example:

"Agents retrieved successfully"

​
data
object[]
​
pagination
object