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

# List API keys

> Lists the API keys issued for your tenant, one row per key carrying `key_id`, `name`, `label`, `status`, `secret_prefix`, `secret_suffix`, `expires_at`, `last_used_at` and `created_at`. The secret itself is never returned here: only the create response carries it, so a key whose secret was not stored has to be replaced rather than recovered. Filter with `status`, which takes `active`, `expired` or `revoked`, and page with `page` and `limit`. The response `data` carries `items` alongside `total_count`, `page`, `limit`, `total_pages` and `has_next_page`. Returns 403 when your account may not manage keys for this tenant, and 404 when the tenant is not found.



## OpenAPI

````yaml /openapi/kintra-app.json get /tenant/{tenantId}/api-keys
openapi: 3.0.0
info:
  description: >-
    Tenant portal API for the Kintra loyalty platform. Requests are
    authenticated with an Auth0 bearer token and address a tenant by id in the
    path.
  title: Kintra Portal API
  version: 1.0.0
servers:
  - description: Production environment
    url: https://api.kintra.io/api/v1
security: []
paths:
  /tenant/{tenantId}/api-keys:
    get:
      tags:
        - API keys
      summary: List API keys
      description: >-
        Lists the API keys issued for your tenant, one row per key carrying
        `key_id`, `name`, `label`, `status`, `secret_prefix`, `secret_suffix`,
        `expires_at`, `last_used_at` and `created_at`. The secret itself is
        never returned here: only the create response carries it, so a key whose
        secret was not stored has to be replaced rather than recovered. Filter
        with `status`, which takes `active`, `expired` or `revoked`, and page
        with `page` and `limit`. The response `data` carries `items` alongside
        `total_count`, `page`, `limit`, `total_pages` and `has_next_page`.
        Returns 403 when your account may not manage keys for this tenant, and
        404 when the tenant is not found.
      operationId: TenantApiKeys
      parameters:
        - in: path
          name: tenantId
          required: true
          schema:
            type: string
        - in: query
          name: status
          required: false
          schema:
            $ref: '#/components/schemas/TenantApiKeyStatus'
        - in: query
          name: page
          required: false
          schema:
            default: 1
            format: double
            type: number
        - in: query
          name: limit
          required: false
          schema:
            default: 10
            format: double
            type: number
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ApiResponse_IPaginationResponse_ITenantApiKeyResponseDto__
          description: ''
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Unauthorized
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Forbidden
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Tenant not found
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiResponse_null_'
          description: Internal server error
      security:
        - auth0_jwt: []
components:
  schemas:
    TenantApiKeyStatus:
      enum:
        - active
        - expired
        - revoked
      type: string
    ApiResponse_IPaginationResponse_ITenantApiKeyResponseDto__:
      additionalProperties: false
      properties:
        data:
          $ref: '#/components/schemas/IPaginationResponse_ITenantApiKeyResponseDto_'
        errors:
          items:
            properties:
              message:
                type: string
              path:
                type: string
            required:
              - path
              - message
            type: object
          type: array
        message:
          type: string
        success:
          type: boolean
      required:
        - success
      type: object
    ApiResponse_null_:
      additionalProperties: false
      properties:
        data:
          enum:
            - null
          nullable: true
          type: number
        errors:
          items:
            properties:
              message:
                type: string
              path:
                type: string
            required:
              - path
              - message
            type: object
          type: array
        message:
          type: string
        success:
          type: boolean
      required:
        - success
      type: object
    IPaginationResponse_ITenantApiKeyResponseDto_:
      additionalProperties: false
      properties:
        has_next_page:
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/ITenantApiKeyResponseDto'
          type: array
        limit:
          format: double
          type: number
        page:
          format: double
          type: number
        total_count:
          format: double
          type: number
        total_pages:
          format: double
          type: number
      required:
        - total_count
        - page
        - limit
        - has_next_page
        - total_pages
        - items
      type: object
    ITenantApiKeyResponseDto:
      additionalProperties: false
      properties:
        created_at:
          format: date-time
          type: string
        expires_at:
          format: date-time
          nullable: true
          type: string
        id:
          type: string
        key_id:
          type: string
        label:
          nullable: true
          type: string
        last_used_at:
          format: date-time
          nullable: true
          type: string
        name:
          type: string
        secret_prefix:
          type: string
        secret_suffix:
          type: string
        status:
          anyOf:
            - $ref: '#/components/schemas/TenantApiKeyStatus'
            - type: string
        updated_at:
          format: date-time
          type: string
      required:
        - id
        - key_id
        - name
        - secret_prefix
        - secret_suffix
        - status
      type: object
  securitySchemes:
    auth0_jwt:
      bearerFormat: JWT
      description: Auth0 access token
      scheme: bearer
      type: http

````