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

# Listar API keys

> Apenas tenant-scoped (uma key escopada a número recebe 403 NUMBER_SCOPE_NOT_ALLOWED, e uma concessão OAuth precisa ser de tenant completo). Retorna uma lista enxuta e plana — um item por número do tenant — com numberId, number, displayName, keyId, keyLast4 e o valor real utilizável (campo `key`) quando a chave foi criada com criptografia ativa (`revealable: true`). Chaves antigas vêm com `key: null` e `revealable: false` (regenere aquele número para obter um valor utilizável).

**Requer uma chave com escopo de tenant.**



## OpenAPI

````yaml openapi.pt.json GET /v1/api-keys
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/api-keys:
    get:
      tags:
        - API Keys
      summary: Listar API keys
      description: >-
        Apenas tenant-scoped (uma key escopada a número recebe 403
        NUMBER_SCOPE_NOT_ALLOWED, e uma concessão OAuth precisa ser de tenant
        completo). Retorna uma lista enxuta e plana — um item por número do
        tenant — com numberId, number, displayName, keyId, keyLast4 e o valor
        real utilizável (campo `key`) quando a chave foi criada com criptografia
        ativa (`revealable: true`). Chaves antigas vêm com `key: null` e
        `revealable: false` (regenere aquele número para obter um valor
        utilizável).


        **Requer uma chave com escopo de tenant.**
      operationId: get_api-keys
      responses:
        '200':
          description: Listar keys (key do tenant — todos os números)
          content:
            application/json:
              example:
                - numberId: wn_1
                  number: '5511999999999'
                  displayName: Suporte
                  keyId: k_aaa
                  keyLast4: wxyz
                  key: ps_4f1c...real...wxyz
                  revealable: true
                - numberId: wn_2
                  number: '5511888888888'
                  displayName: Vendas
                  keyId: k_bbb
                  keyLast4: abcd
                  key: null
                  revealable: false
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de número usada em endpoint exclusivo de tenant
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Number-scoped keys cannot call tenant endpoints
                code: NUMBER_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````