SaaS SDKSaaS APIagents

List agents

View as Markdown

List agents with optional filters (status, departmentId, projectId, unassigned, environment, search) and sorting (sortBy=name|createdAt, sortDir=asc|desc). projectId and unassigned are mutually exclusive. When Collector is configured, period cost/requests/tokens and meta.costBreakdown are merged from GET /v1/analytics/saas/costs-by-entities with entityType=agent. Owner, admin, viewer.

Headers

AuthorizationstringRequired

Bearer {access_token}

X-Workspace-IdstringRequired
Workspace UUID

Query parameters

pageintegerOptionalDefaults to 1
Page number
pageSizeintegerOptionalDefaults to 20
Items per page
statusstringOptional
active, inactive, archived
departmentIdstringOptional
Department UUID
projectIdstringOptionalformat: "uuid"

Project UUID (mutually exclusive with unassigned)

unassignedbooleanOptional

Only agents without a project (mutually exclusive with projectId)

environmentstringOptional
production, development, staging
searchstringOptional

Search name/description

sortByenumOptionalDefaults to createdAt
Sort field
Allowed values:
sortDirenumOptionalDefaults to desc
Sort direction
Allowed values:

Response

data: list, meta: pagination

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error