KEkeycardai
User Agents

List user agents

Changed on

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.

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
    • HTTP bearer
    • or OAuth 2
      Client credentials
      Token URL: /service-account-token

Path parameters

zoneIdstring required

Zone ID

Query parameters

afterstring

Cursor for forward pagination

beforestring

Cursor for backward pagination

limitinteger

Maximum number of items to return

'total_count'
OR
string[]
string

Restrict results to user agents with this ID. Repeatable, max 100. Mutually exclusive with after/before.

OR
string[]
string

Filter by exact identifier (OAuth client_id)

OR
string[]

Response

Default Response

Changes

  • 0dee67e0a73aRevision changes
    • info

      added the new optional query request parameter filter[id]

    • info

      added the new optional query request parameter filter[identifier]

    • info

      added the non-success response with the status

  • d3d69f45bfedRevision changes
    • info

      the endpoint scheme security OAuth2 was added to the API

    • info

      the endpoint scheme security bearerAuth was added to the API

    • info

      the endpoint scheme security iam_bearerAuth was removed from the API