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

# List Keys

> **Who may call it:** admin. A workspace API key is refused here: this is an act that belongs to a named person.



## OpenAPI

````yaml /api/openapi.json get /v1/keys
openapi: 3.1.0
info:
  title: RotaGrant API
  version: 0.1.0
  description: >-
    The HTTP API of a RotaGrant deployment, made from the product's own route
    definitions at the commit named in `x-rotascale-source`. Nothing here is
    written by hand.


    There is no shared endpoint. RotaGrant runs in your environment, and your
    deployment serves its own copy of this description at `/api/docs`. That copy
    is the authority on what your version has and which features are switched
    on; this one is the reference for one commit of the main line. The version
    is 0.1.0: routes and shapes can still change.


    Every route says who may call it. Most need a bearer token from the identity
    provider your deployment uses, held by a person with the role named. The
    routes an SDK calls also accept a workspace API key. A few are open, and say
    why.
servers:
  - url: https://{deployment}
    description: Your own deployment. There is no shared endpoint.
    variables:
      deployment:
        default: rotagrant.internal.example
        description: The host your deployment answers on.
security: []
paths:
  /v1/keys:
    get:
      tags:
        - API keys
      summary: List Keys
      description: >-
        **Who may call it:** admin. A workspace API key is refused here: this is
        an act that belongs to a named person.
      operationId: list_keys_v1_keys_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeysOut'
      security:
        - bearerToken: []
components:
  schemas:
    ApiKeysOut:
      properties:
        keys:
          items:
            $ref: '#/components/schemas/ApiKeyOut'
          type: array
          title: Keys
        count:
          type: integer
          title: Count
        never_used:
          items:
            type: string
          type: array
          title: Never Used
        dormant:
          items:
            type: string
          type: array
          title: Dormant
      type: object
      required:
        - keys
        - count
        - never_used
        - dormant
      title: ApiKeysOut
    ApiKeyOut:
      properties:
        id:
          type: string
          title: Id
        name:
          type: string
          title: Name
        environment:
          type: string
          title: Environment
        scope_source:
          type: string
          title: Scope Source
        display:
          type: string
          title: Display
        created_by:
          type: string
          title: Created By
        created_at:
          type: string
          format: date-time
          title: Created At
        expires_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Expires At
        last_used_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Last Used At
        revoked_at:
          anyOf:
            - type: string
              format: date-time
            - type: 'null'
          title: Revoked At
        revocation_reason:
          anyOf:
            - type: string
            - type: 'null'
          title: Revocation Reason
        active:
          type: boolean
          title: Active
        never_used:
          type: boolean
          title: Never Used
        dormant:
          type: boolean
          title: Dormant
      type: object
      required:
        - id
        - name
        - environment
        - scope_source
        - display
        - created_by
        - created_at
        - active
        - never_used
        - dormant
      title: ApiKeyOut
      description: One key. Never the secret — that is shown once, at creation, and gone.
  securitySchemes:
    bearerToken:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        A token from the identity provider your deployment federates with. It
        identifies a person; their roles in the workspace decide what they may
        do.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.