---
title: "Paginated list of infrastructure and failure flag agents"
method: GET
path: "/agents"
tags: ["agents"]
---

# Paginated list of infrastructure and failure flag agents

`GET /agents`

Requires the privilege [`CLIENTS_READ`](https://www.gremlin.com/docs/user-management/access-control/#privileges)

## Query parameters

- `pageSize` integer
- `pageToken` PageToken
  - `cacheKey` string
  - `lastEvaluatedSK` string
- `teamId` string, required

## Response `default`

default response

- PagedResponseAgentResponse
  - `pageNumber` integer
  - `pageSize` integer — The size of the page requested. If none was supplied this is a default value (depending on the endpoint). If the length of items is less than this number that means there are _no_ more pages to request. NOTE: if the length *is* equal there may or may not be additional pages to request, it is unknowable until they are requested
  - `pageToken` string — Supply this token on successive requests to retrieve the next page if there is one
  - `items` AgentResponse[]
    - `id` string
    - `type` 'Infrastructure' | 'FailureFlag'
    - `status` 'Active' | 'Idle' | 'Deactivated'
    - `warningCount` integer
    - `instanceCount` integer — For Failure Flags applications this is the recent/active instance count for that application. This value may be null when the count is unknown or unavailable (for example, legacy apps or not yet computed). For Infra this field is null.
    - `tags` object

## Other responses

- `401` — Authorization header missing or malformed. Please provide proper credentials in the authorization header.
- `403` — User requires privilege for target team: CLIENTS_READ

---

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