Skip to main content
GET

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

workspaceId
string
required

Workspace ID.

Example:

"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"

Query Parameters

limit
integer<int32>

Maximum number of results to return

cursor
string

Pagination cursor from previous response

prefix
string

Filter expression (query param: prefix)

query
string

Free-form search query

state
enum<string>

Filter by lifecycle state. Unspecified returns active and inactive pools; explicitly select ARCHIVED to list archived pools.

Available options:
AGENT_POOL_STATE_UNSPECIFIED,
AGENT_POOL_STATE_ACTIVE,
AGENT_POOL_STATE_INACTIVE,
AGENT_POOL_STATE_ARCHIVED
labels
string

Filters by metadata labels. Comma-separated key=value pairs, e.g. "env=prod,team=ai". A resource matches only if every pair matches exactly (AND semantics).

sortOrder
string

Sort order for results (asc or desc by creation time)

includeInfo
boolean

When true, the info field on each returned agent pool is populated. Requests with this flag count more against your rate limit.

Response

OK

List agent pools response

items
object[]
required
pagination
object

Page carries cursor-based pagination state. There is no total: the cursor walks the result set without ever counting it, and a count would cost a second query on every list.