---
title: "Lists Agent Pools."
method: GET
path: "/api/test-distribution/agent-pools"
tags: ["TestDistribution", "GradleEnterprise", "Develocity"]
---

# Lists Agent Pools.

`GET /api/test-distribution/agent-pools`

## Request

- Base URL: `https://develocity.example.com`
- URL: `https://develocity.example.com/api/test-distribution/agent-pools`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/develocity/apis/develocity-api/docs/api/test-distribution/agent-pools/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of all Agent Pools.

## Response `200`

The response contains a listing of all Agent Pools.

- TestDistributionAgentPoolPage: A list of agent pools.
  - `content` TestDistributionAgentPoolConfigurationWithId[], required: A list of agent pool IDs.
    - `id` string, required: The unique identifier of the agent pool.
    - `name` string, required: The alias or display name of the agent pool.
    - `minimumSize` integer, required
    - `maximumSize` integer, required
    - `orderIndex` integer, required: The order in which the agent pool is considered for allocation. Lower values are considered first.
    - `capabilities` string[], required
    - `restrictAccessToProjectGroups` boolean: Controls whether this pool can be used by everyone, or only the assigned project groups. A `true` value implies that `projectGroupIds` is present and has at least one entry. Conversely, a `false` value implies that `projectGroupIds` is empty.
    - `projectGroupIds` string[]: Controls which project groups can use this pool. If it is empty, then `restrictAccessToProjectGroups` must be `false`. Conversely, if it has values then `restrictAccessToProjectGroups` must be `true`.

## Other responses

- `403`: The authenticated user has insufficient permissions.
- `404`: No API key was specified in the request, the key has been revoked, or the user bearing the key lacks permissions for this operation.

---

[API](https://skmtc.dev/develocity/apis/develocity-api.md) - [All operations](https://skmtc.dev/develocity/apis/develocity-api/llms.txt) - [OpenAPI document](https://skmtc.dev/develocity/apis/develocity-api/revisions/b49835fbf065?raw)