---
title: "List user agents"
method: GET
path: "/zones/{zoneId}/user-agents"
tags: ["User Agents"]
---

# List user agents

`GET /zones/{zoneId}/user-agents`

## Request

- Base URL: `https://docs.keycard.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://docs.keycard.ai/zones/{zoneId}/user-agents`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Client credentials
    - Token URL: `/service-account-token`

Returns the user agents in the specified zone, cursor-paginated and ordered by name. User agents represent client software (browsers, desktop apps, CLI tools) registered via OAuth 2.0 Dynamic Client Registration. Pass `filter[id]` (repeatable, max 100) to restrict results to a known set of user agents — mutually exclusive with `after`/`before` (returns 400 if combined). When `filter[id]` is set, `limit` is ignored and the response contains every requested user agent that exists in the zone, in a single page. IDs not in the zone are silently omitted.

## Path parameters

- `zoneId` string, required

## Query parameters

- `after` string
- `before` string
- `limit` integer
- `expand[]` union
  - 'total_count'
  - string[]
- `filter[id]` union
  - string: Restrict results to user agents with this ID. Repeatable, max 100. Mutually exclusive with after/before.
  - string[]
- `filter[identifier]` union
  - string: Filter by exact identifier (OAuth client_id)
  - string[]

## Response `200`

Default Response

- object
  - `items` IamUserAgent[], required
    - `id` string, required: Unique identifier of the user agent
    - `organization_id` string, required: Organization that owns this user agent
    - `zone_id` string, required: Zone this user agent belongs to
    - `slug` string, required: URL-safe identifier, unique within the zone
    - `identifier` string, required: User agent identifier (serves as OAuth client_id). Format: ua:{sha256_hash}
    - `name` string, required: Human-readable name
    - `created_at` string, date-time, required: Entity creation timestamp
    - `updated_at` string, date-time, required: Entity update timestamp
  - `pagination` IamPagination, required: Cursor-based pagination metadata
    - `after_cursor` string, required: An opaque cursor used for paginating through a list of results
    - `before_cursor` string, required: An opaque cursor used for paginating through a list of results
    - `total_count` integer: Total number of items matching the query. Only included when expand[]=total_count is requested.

## Other responses

- `400`: Error response
- `default`: Error response

## Changes

- **2026-10-29** `0dee67e0a73a`: 3 info
  - added the new optional `query` request parameter `filter[id]`
  - added the new optional `query` request parameter `filter[identifier]`
  - added the non-success response with the status `400`
- **2026-03-16** `d3d69f45bfed`: 3 info
  - the endpoint scheme security `OAuth2` was added to the API
  - the endpoint scheme security `bearerAuth` was added to the API
  - the endpoint scheme security `iam_bearerAuth` was removed from the API
- **2026-03-09** `cb43483cd1b3`: 5 info
  - added the new optional `query` request parameter `after`
  - added the new optional `query` request parameter `before`
  - added the new optional `query` request parameter `expand[]`
  - added the new optional `query` request parameter `limit`
  - …1 more

[Operation history](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/changes/zones/:zoneId/user-agents/get.md)

---

[API](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api.md) - [All operations](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/llms.txt) - [OpenAPI document](https://skmtc.dev/keycardai/apis/keycard-ai-keycard-api/revisions/0dee67e0a73a?raw)