---
title: "List Agents"
method: GET
path: "/api/v2/projects/{project_id}/agents"
tags: ["Agents"]
---

# List Agents

`GET /api/v2/projects/{project_id}/agents`

Retrieve a paginated list of agents for your project. Optionally filter by name.

`page_size` defaults to 30, maximum 100.

## Path parameters

- `project_id` string, required

## Query parameters

- `page` integer
- `page_size` integer
- `name` string, nullable

## Response `200`

GetAgentsResponsePayload(data: list[server.api_routes.agents_api_v2.AgentInfo], pagination: server.api_routes.api_v2_common.PaginationInfo)

- object
  - `data` AgentInfo[], required
    - `id` string, uuid, required
    - `name` string, required
  - `pagination` PaginationInfo, required
    - `page` integer, required
    - `page_size` integer, required
    - `has_next` boolean, required

---

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