Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

OAuth 2.0 / OIDC bearer token.

Tenant-Name
string
header
required

The tenant the request operates within.

Query Parameters

pageSize
integer
default:50

Maximum number of items per page.

Required range: 1 <= x <= 200
pageToken
string

Opaque cursor from a prior response's nextPageToken. Omit on the first request.

visibility
enum<string>[]

Filter by one or more visibility levels.

  • private — creator / service principal only.
  • unlisted — usable by ID, hidden from list results.
  • public — listed tenant-wide.
Available options:
private,
unlisted,
public
lifecycle
enum<string>
default:ephemeral

Filter by lifecycle.

  • ephemeral — short-lived; expired automatically.
  • persistent — retained until explicitly deleted.
Available options:
ephemeral,
persistent
label
string[]

Filter by label equality, repeated key=value pairs (AND-combined).

Pattern: ^[^=]+=[^=]*$
q
string

Free-text search over name and description.

Maximum string length: 256
Example:

"coder"

Response

A page of agents.

A page of agents.

agents
object[]
required

Agents on the current page.

Example:
nextPageToken
string | null

Opaque cursor to request the next page, or null if there are no more pages.

totalSize
integer

Total number of items matching the query, when known. Not currently populated by the server; treat as absent.

Example:

42