List agents

POST/api/agents/query

Returns workspace agents using offset pagination.

Request Body

application/json

Request payload for List agents.

TypeScript Definitions

Use the request body type in TypeScript.

limit?|||||

Maximum number of results to return.

offset?|||||

Number of results to skip before returning data.

Response Body

`application/json`

curl -X POST "https://example.com/api/agents/query" \  -H "Content-Type: application/json" \  -d '{}'

[  {    "id": "agent_123",    "workspaceId": "ws_123",    "name": "Renewals assistant",    "description": "Helps account managers follow up on renewals.",    "icon": "bot",    "color": "#1d4ed8",    "data": null,    "createdAt": "2026-04-01T12:00:00.000Z",    "updatedAt": "2026-04-01T12:00:00.000Z",    "deletedAt": "2026-04-01T12:00:00.000Z"  }]

{  "_tag": "ApiBadRequestError",  "code": "PRICE_IMPORT_DUPLICATE_SKUS",  "message": "The request payload is invalid.",  "description": "Remove duplicate SKU rows before importing the file.",  "details": null}

{  "_tag": "Unauthorized"}

{  "_tag": "ApiForbiddenError",  "message": "You do not have permission to perform this action."}

{  "_tag": "ApiNotFoundError",  "message": "The requested resource was not found."}

{  "_tag": "ApiConflictError",  "message": "A resource with this handle already exists."}

{  "_tag": "ApiUnprocessableEntityError",  "message": "The order cannot be submitted without items."}

{  "_tag": "ServiceUnavailable"}

{  "_tag": "ApiTimeoutError",  "message": "The upstream operation timed out."}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`