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

# List API keys

> Retrieve all API keys belonging to your organization, including revoked ones. Key secrets are never returned — only metadata. Requires the `api-keys:read` scope.



## OpenAPI

````yaml api/openapi.json GET /v1/api-keys/
openapi: 3.1.0
info:
  title: SOAX API
  version: v1
  description: >-
    Programmatic access to your SOAX account: manage proxy packages, generate
    connection strings, browse available locations, pull usage analytics, and
    manage API keys. All endpoints are served over HTTPS and return JSON.
servers:
  - url: https://api.platform.soax.com
security:
  - bearerAuth: []
tags:
  - name: API Keys
    description: >-
      Self-service management of the API keys used to authenticate with this
      API.
  - name: Packages
    description: >-
      Read proxy packages, build proxy connection strings, and rotate package
      passwords.
  - name: Locations
    description: >-
      Location reference data: tiers, countries, regions, cities, ISPs, ASNs,
      and ZIP codes.
  - name: Account
    description: Read-only account, credit, and subscription information.
  - name: Analytics
    description: Usage analytics for your proxy packages.
paths:
  /v1/api-keys/:
    get:
      tags:
        - API Keys
      summary: List all API keys for the authenticated customer
      description: >-
        Retrieve all API keys belonging to your organization, including revoked
        ones. Key secrets are never returned — only metadata. Requires the
        `api-keys:read` scope.
      operationId: list_api_keys_v1_api_keys__get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                items:
                  $ref: '#/components/schemas/ApiKeySummaryResponse'
                type: array
                title: Response List Api Keys V1 Api Keys  Get
              example:
                - id: 3f8a2c1e-5b6d-4e7f-8a9b-0c1d2e3f4a5b
                  name: Production backend
                  scopes:
                    - proxy:packages:read
                    - proxy:analytics:read
                    - account:read
                    - api-keys:read
                    - api-keys:write
                  package_ids: null
                  status: active
                  created_at: '2026-06-01T09:30:00Z'
                  updated_at: '2026-06-01T09:30:00Z'
                  last_used_at: '2026-08-11T08:14:52Z'
                - id: 7c2d9e0f-1a2b-4c3d-8e9f-a0b1c2d3e4f5
                  name: CI analytics reader
                  scopes:
                    - proxy:analytics:read
                  package_ids:
                    - b2f0c3d4-e5a6-4b7c-8d9e-0f1a2b3c4d5e
                  status: revoked
                  created_at: '2026-04-20T15:00:00Z'
                  updated_at: '2026-07-01T10:00:00Z'
                  last_used_at: '2026-06-30T23:59:01Z'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/ForbiddenScope'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    ApiKeySummaryResponse:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        scopes:
          items:
            type: string
          type: array
          title: Scopes
        package_ids:
          anyOf:
            - items:
                type: string
              type: array
            - type: 'null'
          title: Package Ids
        status:
          type: string
          title: Status
        created_at:
          type: string
          format: date-time
          title: Created At
        updated_at:
          type: string
          format: date-time
          title: Updated At
        last_used_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Used At
      type: object
      required:
        - id
        - name
        - scopes
        - package_ids
        - status
        - created_at
        - updated_at
        - last_used_at
      title: ApiKeySummaryResponse
      description: |-
        Response schema for a single API key in a list response.

        Contains key metadata but never exposes the secret or hash.
  responses:
    Unauthorized:
      description: Missing, invalid, or revoked API key.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
          example:
            detail: Invalid API key
    ForbiddenScope:
      description: The API key does not carry the scope this endpoint requires.
      content:
        application/json:
          schema:
            type: object
            properties:
              detail:
                type: string
          example:
            detail: 'Missing required scope: proxy:packages:read'
    RateLimited:
      description: >-
        Rate limit exceeded (5 requests/second per API key, 500 requests/minute
        per IP). The response includes `Retry-After` (seconds),
        `RateLimit-Limit`, `RateLimit-Remaining`, and `RateLimit-Reset` (Unix
        time) headers — wait `Retry-After` seconds and retry.
      content:
        application/json:
          schema:
            type: object
            properties:
              error:
                type: string
          example:
            error: 'Rate limit exceeded: 5 per 1 second'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        API key secret (starts with `s_live_`). Create keys in the dashboard
        under **Settings → API keys**, or via `POST /v1/api-keys/`. Send it as
        `Authorization: Bearer <secret>`.

````