List AI agents
list your AI agents. Read-only; useful to discover agent_id values to pass to the make-AI-call and send-message webhooks. Optional active filter.
GET
https://api.centerfy.ai/webhooks/inbound/agents Headers
| Header | Required | Value | Description |
|---|---|---|---|
x-api-key | Yes | your sub-account API key (cfy_…) | API key; or Authorization: Bearer <key>. |
Query parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
active | boolean | No | — | optional filter on is_active: true returns only active agents, false returns only paused/inactive agents. Omit to return all. |
Example
curl -X GET "https://api.centerfy.ai/webhooks/inbound/agents" \
-H "x-api-key: $CENTERFY_API_KEY" import { CenterfyClient } from "@centerfy/sdk";
const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });
const result = await centerfy.agents.list();
console.log(result); centerfy agents list MCP tool: centerfy_agents_list (see MCP server)
Response
{
"status": "success",
"agent_count": 2,
"agents": [
{
"id": "b2c3d4e5-3333-4abc-9def-000000000030",
"name": "Front Desk AI",
"is_active": true
},
{
"id": "b2c3d4e5-3333-4abc-9def-000000000031",
"name": "After Hours AI",
"is_active": false
}
]
}Errors
401— if unauthenticated; 500 on error.
Notes
Read-only. Agents are ordered newest first by created_at and use a safe public projection. The example agent fields are representative.