Skip to main content
GET
/
public
/
v1
/
agents
List agents
curl --request GET \
  --url https://api.callin.io/api/public/v1/agents \
  --header 'x-api-key: <api-key>'
{
  "success": true,
  "data": [
    {
      "agentId": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "metadata": {
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": {
          "userId": "<string>",
          "userEmail": "<string>"
        }
      }
    }
  ],
  "pagination": {
    "pageSize": 123,
    "hasMore": true,
    "nextCursor": "<string>",
    "sortBy": "name",
    "sortDirection": "asc"
  }
}

Authorizations

​
x-api-key
string
header
required

Send your Callin API key in the x-api-key header.

Query Parameters

​
search
string

Filter agents by name (case-insensitive partial match).

​
sortBy
enum<string>

Field to sort by. Defaults to created_at.

Available options:
name,
created_at
​
sortDirection
enum<string>

Sort order. Defaults to desc.

Available options:
asc,
desc
​
cursor
string

Pagination cursor from the previous response nextCursor. Pass an ISO timestamp when sorting by created_at, or a name string when sorting by name.

​
pageSize
integer
default:30

Number of agents per page. Min 1, max 100, default 30.

Required range: 1 <= x <= 100

Response

A paginated array of agents.

Paginated list of agents with cursor metadata.

​
success
boolean
Example:

true

​
data
object[]

A list of agents and their metadata

​
pagination
object