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

# List API keys

> Your organisation's API keys, including revoked and expired ones. Tokens are never returned: they are shown once, when created or renewed in the console.



## OpenAPI

````yaml /console-openapi.json get /api/v1/keys
openapi: 3.1.0
info:
  title: Caretly Console API
  version: 1.0.0
  description: >-
    Read your organisation's usage, API keys and billing status as JSON.
    Authenticate with any of your API keys, live or test. All endpoints are
    read-only.
servers:
  - url: https://caretly.dev/console
security:
  - bearerAuth: []
paths:
  /api/v1/keys:
    get:
      tags:
        - Console API
      summary: List API keys
      description: >-
        Your organisation's API keys, including revoked and expired ones. Tokens
        are never returned: they are shown once, when created or renewed in the
        console.
      operationId: listKeys
      responses:
        '200':
          description: The organisation's keys.
          headers:
            Cache-Control:
              $ref: '#/components/headers/CacheControl'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/KeyList'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  headers:
    CacheControl:
      description: Always `no-store`.
      schema:
        type: string
        example: no-store
  schemas:
    KeyList:
      type: object
      required:
        - keys
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/Key'
    Key:
      type: object
      required:
        - id
        - name
        - type
        - created_at
        - expires_at
        - status
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          example: Warehouse printer
        type:
          type: string
          enum:
            - live
            - test
          description: '`live` keys are billed; `test` keys are free and watermarked.'
        created_at:
          type: string
          format: date-time
          description: When the key was created.
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
          description: Expiry of the key's latest token; `null` if it never expires.
        status:
          type: string
          enum:
            - active
            - expired
            - revoked
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
          description: What went wrong.
  responses:
    Unauthorized:
      description: The API key is missing, invalid, expired or revoked.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              This API key has been revoked. Send one of your API keys as
              `Authorization: Bearer <key>`; manage keys at
              https://caretly.dev/console/keys
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        One of your API keys (`zpl_live_…` or `zpl_test_…`), created at
        https://caretly.dev/console/keys. Revoked keys are refused immediately.

````

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