Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

A personal API key or an OAuth 2.0 access token. Personal API keys also require the x-auth-key header with your user ID.

Query Parameters

team_id
string

Scope the listing to a single team. Get team IDs from List teams. When omitted, returns agents owned by the authenticated user; their team_id is the user's own ID.

Case-insensitive substring match against the agent name.

creator
string

Filter to agents created by this user ID.

has_triggers
boolean

When true, only returns agents that have at least one active trigger configured.

tool
string

Filter to agents that use the specified MCP server as a tool.

flow
string

Filter to agents that use the specified saved flow as a tool.

sort_order
enum<string>
default:newest

Sort order for the listing. Defaults to newest first.

Available options:
newest,
oldest,
name_asc,
name_desc
include_last_used
boolean

When true, populates last_used_at on each agent with the timestamp of its most recent session.

include_last_updated
boolean

When true, populates last_updated_at on each agent with the timestamp of its most recent configuration change.

summary
boolean
default:false

When true, each item is an AgentSummary (identity, model, creator and activity fields) rather than the whole Agent configuration. Drops system_prompt, tools, resources and metadata, which make up most of a large team's list payload. Combine with page_size to browse a large team in small pages.

page_size
integer
default:20

Number of agents per page. Sending page_size or cursor opts into cursor pagination; requests that send neither return the full list.

Required range: 1 <= x <= 100
cursor
string

Opaque cursor from a previous response's next_cursor. Pass it to fetch the next page.

Response

Agents matching the provided filters.

agents
object[]

Agent items by default; AgentSummary items when the request sent summary=true.

An agent and its whole configuration. Single-agent retrieve, create and update return this shape; the list endpoint does not populate the inlined collections, abilities or version. Collection-specific writes return their own result shapes.

next_cursor
string | null

Cursor for the next page. Present only on paginated requests; null when there are no more results.

Example:

null