Skip to main content
GET
List Agents

Authorizations

x-api-key
string
header
required

API key for authentication. Generate API keys from the RevRing dashboard.

Query Parameters

page
integer
default:1

Page number

Required range: x >= 1
pageSize
integer
default:25

Items per page

Required range: 1 <= x <= 100
sortBy
enum<string>
default:createdAt

Sort field

Available options:
createdAt,
updatedAt,
name
sortDir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
status
enum<string>

Filter by status

Available options:
active,
disabled
folderId
string

Filter by folder. Pass a folder ID to only return agents in that folder, or none to only return agents not in any folder. Omit to return agents from all folders.

q
string

Search agents by name (case-insensitive substring match)

Maximum string length: 128
minimal
boolean
default:false

Return a compact representation, omitting prompt template, flow definition, variables, runtime config, custom tools, and knowledge bases

Response

Paginated list of agents

Paginated list of agents

data
object[]
required

Array of agents on the current page

page
integer
required
Required range: x >= 1
pageSize
integer
required
Required range: 1 <= x <= 100
total
integer
required
hasNextPage
boolean
required