Skip to content
UltimateTeam.ai Docs

List agents

GET
/api/v1/agents
curl --request GET \
  --url https://api.ultimateteam.ai/api/v1/agents \
  --header 'X-API-Key: <X-API-Key>'

Return all agent configs for the authenticated tenant.

Authorizations

Section titled “Authorizations”

Responses

Section titled “ Responses ”

200

Section titled “200”

Successful Response

Media typeapplication/json
AgentListResponse

Wrapper response for GET /agents.

Attributes: data: The agent list payload.

object
data
required
AgentListData

Payload for GET /agents list response.

Attributes: agents: List of agent summaries. total: Total count.

object
agents
required
Agents
Array<object>
AgentSummary

Compact agent representation for the list endpoint.

Attributes: role: Agent role identifier (e.g. "cmo"). display_name: Human-readable name. agent_name: Optional persona name. status: Lifecycle status ("active" | "paused"). model_tier: The LLM tier this agent uses. color: Optional hex color for UI display. forged: Whether this is a custom-forged agent.

object
agent_name
required
Any of:
string
color
required
Any of:
string
display_name
required
Display Name
string
forged
required
Forged
boolean
model_tier
required
Model Tier
string
role
required
Role
string
status
required
Status
string
total
required
Total
integer
Examplegenerated
{
  "data": {
    "agents": [
      {
        "agent_name": "example",
        "color": "example",
        "display_name": "example",
        "forged": true,
        "model_tier": "example",
        "role": "example",
        "status": "example"
      }
    ],
    "total": 1
  }
}