> ## Documentation Index
> Fetch the complete documentation index at: https://docs.proxyscrape.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List API keys

> List API keys for the account. Returns key metadata (id, name, permissions, scopes, expiry, `is_active`) but never the secret. Supports status/search filters and optional pagination. Inactive keys are included when `status` is `all` or `inactive`. Permission: `account:apikeys:read`.



## OpenAPI

````yaml /openapi-account.json get /v4/account/api-keys
openapi: 3.0.3
info:
  title: ProxyScrape Account API
  description: Account API — authenticate with the api-token header.
  version: 1.0.0
servers:
  - url: https://api.proxyscrape.com
    description: ProxyScrape API
security:
  - apiToken: []
tags:
  - name: API key management
    description: Create, list, update, regenerate, and revoke API keys
  - name: Subaccounts
    description: List subaccounts and manage preferences
  - name: Datacenter
    description: 'Datacenter shared and dedicated: overview, proxy list, usage, whitelist'
  - name: Residential
    description: 'Residential (bandwidth): overview, subusers, usage'
  - name: Residential unlimited
    description: 'Residential unlimited: overview, statistics, password'
  - name: SERP API
    description: 'SERP API: overview, subusers, search'
  - name: API ordering
    description: >-
      Place wallet-paid orders and read the wallet balance via the headless API
      ordering surface.
paths:
  /v4/account/api-keys:
    get:
      tags:
        - API key management
      summary: List API keys
      description: >-
        List API keys for the account. Returns key metadata (id, name,
        permissions, scopes, expiry, `is_active`) but never the secret. Supports
        status/search filters and optional pagination. Inactive keys are
        included when `status` is `all` or `inactive`. Permission:
        `account:apikeys:read`.
      operationId: listApiKeys
      parameters:
        - name: status
          in: query
          required: false
          schema:
            type: string
            enum:
              - all
              - active
              - inactive
            default: all
          description: >-
            Filter by key status. `all` (default) returns active and inactive
            keys; `active` / `inactive` return only that status.
        - name: search
          in: query
          required: false
          schema:
            type: string
          description: Case-insensitive substring match against the key name.
        - name: page
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
            default: 1
          description: Page number (1-based). Used with `limit`.
        - name: limit
          in: query
          required: false
          schema:
            type: integer
            minimum: 1
          description: >-
            Page size. When set to a value greater than 0, the response includes
            a `meta` object with pagination fields.
      responses:
        '200':
          description: >-
            List of API keys (no secrets). When `limit` > 0, includes pagination
            `meta`.
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          format: uuid
                        name:
                          type: string
                        permissions:
                          type: array
                          items:
                            type: string
                        allowed_subaccounts:
                          type: array
                          items:
                            type: string
                        allowed_ips:
                          type: array
                          items:
                            type: string
                        expires_at:
                          type: integer
                          nullable: true
                        is_active:
                          type: boolean
                          description: >-
                            Whether the key can authenticate requests.
                            Deactivating a key sets this to false without
                            deleting it.
                        last_used_at:
                          type: integer
                          nullable: true
                          description: Unix timestamp of last use. Null if never used.
                        token_preview:
                          type: string
                          nullable: true
                        created_at:
                          type: integer
                          description: Unix timestamp of creation.
                  meta:
                    type: object
                    description: Present when `limit` > 0.
                    properties:
                      total:
                        type: integer
                        description: Total keys matching the filters (before pagination).
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Unauthorized
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
                    example: false
                  error:
                    type: string
                    example: Failed to fetch API keys
      security:
        - apiToken: []
components:
  securitySchemes:
    apiToken:
      type: apiKey
      in: header
      name: api-token
      description: >-
        API key. Create and manage keys at /v4/account/api-keys or in the
        dashboard.

````