---
title: "List Agent Pools"
method: GET
path: "/agent-pools"
tags: ["agent-pools"]
---

# List Agent Pools

`GET /agent-pools`

This endpoint returns a list of [agent pools](/docs/agent-pools)
by various filters.

## Query parameters

- `query` string
- `filter[agent-pool]` string
- `filter[name]` string
- `filter[vcs-enabled]` string
- `filter[in-use]` string
- `filter[is-shared]` string
- `filter[account]` string
- `filter[environment]` string
- `page[number]` string
- `page[size]` string
- `include` string[]
- `sort` string[]
- `fields` object
  - `accounts` string — The comma-separated list of fields to return in response for Account resource.
  - `agent-pools` string — The comma-separated list of fields to return in response for AgentPool resource.
  - `agents` string — The comma-separated list of fields to return in response for Agent resource.
  - `environments` string — The comma-separated list of fields to return in response for Environment resource.
  - `workspaces` string — The comma-separated list of fields to return in response for Workspace resource.

## Response `200`

Success.

## Other responses

- `404` — User not authorized to perform this action.
- `4XX` — Client error.
- `5XX` — Server error.

---

[API](https://skmtc.net/scalr/apis/scalr-iacp-api.md) · [All operations](https://skmtc.net/scalr/apis/scalr-iacp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalr/scalr-iacp-api/revisions/fc927526ad12/schema)