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

# Listar API keys

> Lista chaves do workspace. Nunca retorna plaintext. `includeRevoked=true` inclui chaves com `revokedAt`. Escopo `api_keys:read`.



## OpenAPI

````yaml /es/platform-api/api-reference/openapi-platform.json get /v1/platform/api-keys
openapi: 3.0.3
info:
  title: Notifique API Platform
  description: >-
    Conta, billing, API keys, equipe e tudo que o painel faz — via API. Rotas
    públicas: `register`, `verify`, `login`. Autentique o restante com
    `Authorization: Bearer sk_live_...` ou `x-api-key`. Escopos: `api_keys:*`,
    `billing:*`, `workspace:members:*` conforme a rota.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Produção
security:
  - ntfPlatformBearerAuth: []
  - ntfPlatformApiKeyHeader: []
tags:
  - name: 'Platform: Conta'
    description: Registro, verificação de telefone e login.
  - name: 'Platform: Billing'
    description: >-
      Assinatura, saldo, recarga e histórico de uso de créditos (`billing:read`
      / `billing:manage`).
  - name: 'Platform: API Keys'
    description: Gestão de chaves do workspace (`api_keys:read` / `api_keys:manage`).
  - name: 'Platform: Workspace'
    description: Listagem de workspaces (sessão) e recursos por workspace.
  - name: 'Platform: Equipe'
    description: >-
      Membros e convites (`workspace:members:read` /
      `workspace:members:manage`).
  - name: Sandbox
    description: Mensajes de prueba interceptados en el entorno sandbox.
paths:
  /v1/platform/api-keys:
    get:
      tags:
        - 'Platform: API Keys'
      summary: Listar API keys
      description: >-
        Lista chaves do workspace. Nunca retorna plaintext.
        `includeRevoked=true` inclui chaves com `revokedAt`. Escopo
        `api_keys:read`.
      operationId: ntfPlatform_listApiKeys
      parameters:
        - name: includeRevoked
          in: query
          schema:
            type: boolean
            default: false
          description: Inclui chaves revogadas (soft revoke).
      responses:
        '200':
          description: Lista de chaves.
          content:
            application/json:
              example:
                success: true
                data:
                  - id: clkey_01HABC...
                    name: Bot produção
                    prefix: sk_live_abc1
                    environment: LIVE
                    scopes:
                      - whatsapp:send
                      - whatsapp:read
                    instanceIds:
                      - clinst_01H...
                    domainIds: []
                    pushAppIds: []
                    spendLimitMode: CREDITS
                    spendLimitCredits: 50000
                    spendLimitCents: null
                    usedCredits: 1200
                    usedCents: 0
                    lastUsedAt: '2026-08-14T18:30:00.000Z'
                    createdAt: '2026-08-01T10:00:00.000Z'
                    revokedAt: null
              schema:
                $ref: '#/components/schemas/ntfPlatform_ListApiKeysResponse'
        '401':
          $ref: '#/components/responses/NtfPlatform_Unauthorized'
        '403':
          $ref: '#/components/responses/NtfPlatform_Forbidden'
components:
  schemas:
    ntfPlatform_ListApiKeysResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              prefix:
                type: string
              environment:
                type: string
              scopes:
                type: array
                items:
                  type: string
              instanceIds:
                type: array
                items:
                  type: string
              domainIds:
                type: array
                items:
                  type: object
              pushAppIds:
                type: array
                items:
                  type: object
              spendLimitMode:
                type: string
              spendLimitCredits:
                type: integer
              spendLimitCents:
                nullable: true
              usedCredits:
                type: integer
              usedCents:
                type: integer
              lastUsedAt:
                type: string
              createdAt:
                type: string
              revokedAt:
                nullable: true
      example:
        success: true
        data:
          - id: clxx...
            name: Exemplo
            prefix: string
            environment: string
            scopes:
              - string
            instanceIds:
              - clxx...
            domainIds:
              - {}
            pushAppIds:
              - {}
            spendLimitMode: string
            spendLimitCredits: 1
            usedCredits: 1
            usedCents: 1
            lastUsedAt: string
            createdAt: string
    NtfPlatform_Error:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
        code:
          type: string
        message:
          type: string
          example: Campo inválido ou ausente.
        retryAfter:
          type: integer
          example: 60
      example:
        success: false
        error: string
        code: string
  responses:
    NtfPlatform_Unauthorized:
      description: Credenciais ou token inválidos.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPlatform_Error'
          example:
            success: false
            code: VERIFICATION_TOKEN_INVALID
    NtfPlatform_Forbidden:
      description: Escopo ausente ou sem acesso ao workspace.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/NtfPlatform_Error'
          example:
            success: false
            code: FORBIDDEN
  securitySchemes:
    ntfPlatformBearerAuth:
      type: http
      scheme: bearer
      description: API key (`sk_live_...`) ou `sessionToken` de login.
    ntfPlatformApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: Alternativa ao Bearer.

````