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

# List API keys using a SimplePay customer session



## OpenAPI

````yaml /openapi.json get /v1/api-keys
openapi: 3.1.0
info:
  title: SimplePay API
  version: '2026-06-13'
  description: >-
    Contrato público para integrar SimplePay desde un backend. Incluye
    únicamente operaciones para comercios y administración protegida de
    credenciales.
servers:
  - description: Live
    url: https://api.simplepay.mx
  - description: Sandbox
    url: https://api.test.simplepay.mx
security:
  - SimplePayApiKey: []
tags:
  - name: API keys
  - name: Hosted Checkout
  - name: Payment Links
  - name: Payments
  - name: Refunds
  - name: Webhooks
  - name: Digital Catalog
  - name: Payment Policy
  - name: Reporting
  - name: Workspace
  - name: Customer Hub
  - name: Bookable Payments
  - name: Table Pay
  - name: Physical Checkout
  - name: In-person Payments
  - name: Terminal
  - name: Tap to Pay
  - name: Ticketing
  - name: Admission Control
  - name: Intelligence
externalDocs:
  description: SimplePay developer documentation
  url: https://docs.simplepay.mx
paths:
  /v1/api-keys:
    get:
      tags:
        - API keys
      summary: List API keys using a SimplePay customer session
      operationId: listApiKeys
      parameters:
        - name: tenant_id
          in: query
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
            pattern: ^[A-Za-z0-9][A-Za-z0-9_-]{0,127}$
        - name: tenant_environment
          in: query
          required: true
          schema:
            type: string
            enum:
              - sandbox
              - live
      responses:
        '200':
          description: Tenant/environment-scoped API credential list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiKeyList'
      security:
        - SimplePayCustomerBearer: []
components:
  schemas:
    ApiKeyList:
      type: object
      additionalProperties: false
      required:
        - can_manage
        - keys
        - live_ready
        - object
      properties:
        can_manage:
          type: boolean
        keys:
          type: array
          items:
            $ref: '#/components/schemas/ApiKeySummary'
        live_ready:
          type: boolean
        object:
          const: simplepay.v1.api_keys
    ApiKeySummary:
      type: object
      additionalProperties: false
      required:
        - created_at
        - created_by_email
        - description
        - environment
        - expires_at
        - id
        - obfuscated_value
        - scopes
        - status
      properties:
        created_at:
          type:
            - string
            - 'null'
          format: date-time
        created_by_email:
          type:
            - string
            - 'null'
          format: email
        description:
          type: string
          maxLength: 120
        environment:
          type: string
          enum:
            - sandbox
            - live
        expires_at:
          type:
            - string
            - 'null'
          format: date-time
        id:
          type: string
          format: uuid
        obfuscated_value:
          type: string
        scopes:
          type: array
          uniqueItems: true
          items:
            type: string
        status:
          type: string
          enum:
            - active
            - failed
            - provisioning
            - revoked
            - revoking
            - rotating
  securitySchemes:
    SimplePayApiKey:
      type: http
      scheme: bearer
    SimplePayCustomerBearer:
      type: http
      scheme: bearer
      description: SimplePay customer session bearer. Never a tenant API credential.

````