Skip to main content
GET
List agents
Returns a JSON array of workspace agents. Each item includes the numeric management id, name, lifecycle status, agent UUID, folder, and run count. Use Get an agent to retrieve its definition and configuration. Omit status to list all agents, or supply a single status or comma-separated statuses such as active,archived. This endpoint does not paginate. An empty array is a successful response when no agents match. With an API key, send X-VOAI-ORGANIZATION-ID for a workspace where the key owner is a current member. The same key can access the owner’s other workspaces by changing that header; its permissions follow the owner’s role in each workspace.

Authorizations

Authorization
string
header
required

Bandwidth Labs OAuth access token. Uses the user's selected workspace; the workspace header is not required. Do not also send an API key. Bearer-only operations may additionally require the Labs super_user role.

Headers

X-VOAI-ORGANIZATION-ID
string | null

Required with X-BW-LABS-AGENTS-API-KEY: the positive local workspace ID to access. The key owner must be a current member. Missing or invalid IDs return 400; non-member workspaces return 403. Not required for bearer authentication, which uses the user's selected workspace.

Query Parameters

status
string | null

Filter by status - can be single value (active/archived) or comma-separated (active,archived)

Response

Successful Response

created_at
string<date-time>
required
id
integer
required

Numeric workspace agent ID used by management endpoints.

name
string
required
status
string
required
total_runs
integer
required

Number of runs recorded for this agent.

assistant_mode
string | null
created_by
string | null
folder_id
integer | null

Workspace folder ID, or null for Uncategorized.

workflow_uuid
string | null

Stable agent UUID used by the call-by-agent endpoint.