List agents
List agents in a workspace with supported search, creator, and archive filters.
Endpoint
GET
/api/v1/workspaces/{workspace_id}/agentsAuthentication
| Operation class | Authentication | Minimum role | API key |
|---|---|---|---|
| customer-api | Bearer API key or dashboard session cookie; dashboard mutations also require X-CX-Request: 1. | member | Allowed |
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
workspace_id | path | string | Yes | — |
q | query | string or null | No | — |
page | query | integer | No | — |
include_archived | query | boolean | No | — |
created_by | query | string or null | No | — |
Request body
This operation has no request body.
Example
curl --request GET 'https://operade.ai/api/v1/workspaces/ws_demo/agents' \ --header 'Authorization: Bearer YOUR_API_KEY'
Responses
| Status | Description | Content |
|---|---|---|
4XX | Handled client error | application/json: ErrorResponse |
200 | Successful Response | application/json: AgentListResponse |
4XX application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | ErrorResponse | — | No | Yes | — | — |
error | object | ErrorItem | — | No | Yes | — | — |
error.code | string | — | — | No | Yes | — | — |
error.details | object | — | — | No | No | — | — |
error.message | string | — | — | No | Yes | — | — |
200 application/json response schema
| Field path | Type | Reference | Format | Nullable | Required | Enum | Description |
|---|---|---|---|---|---|---|---|
$ | object | AgentListResponse | — | No | Yes | — | — |
items | array<AgentSummary> | — | — | No | Yes | — | — |
items[] | object | AgentSummary | — | No | Yes | — | — |
items[].active_version_id | string | — | — | No | Yes | — | — |
items[].archived_at | string or null | — | date-time | Yes | Yes | — | — |
items[].conversations_7d | integer | — | — | No | Yes | — | — |
items[].created_at | string | — | date-time | No | Yes | — | — |
items[].created_by | object | AgentCreator | — | No | Yes | — | — |
items[].created_by.email | string | — | — | No | Yes | — | — |
items[].created_by.name | string | — | — | No | Yes | — | — |
items[].id | string | — | — | No | Yes | — | — |
items[].model | string or null | — | — | Yes | Yes | — | — |
items[].name | string | — | — | No | Yes | — | — |
items[].tags | array<string> | — | — | No | Yes | — | — |
items[].tags[] | string | — | — | No | Yes | — | — |
items[].updated_at | string | — | date-time | No | Yes | — | — |
Response example
{
"items": []
}Errors
Reviewed common and route-declared errors are summarized here; the list is not exhaustive. Start with the distributed error index to find each code's canonical domain page.
| Status | Code | Description |
|---|---|---|
401 | unauthenticated | Authentication is missing, invalid, or revoked. |
403 | forbidden | The authenticated caller does not have access to this operation. |
404 | not_found | The requested workspace resource was not found. |