> ## Documentation Index > Fetch the complete documentation index at: https://developers.pontua.com.br/llms.txt > Use this file to discover all available pages before exploring further. # Lista as API Keys da unidade de negócio > Lista todas as chaves de API criadas na unidade de negócio do usuário autenticado, com paginação padrão. **O que retorna:** apenas **metadata** (`apiKeyId`, `name`, `isActive`, datas, `createdBy`). **Nunca** retorna o token bruto — esse só aparece uma vez, no momento da criação. Se você perdeu o token, **revogue a chave** (`PATCH /api-key/:id` com `isActive: false`) e crie uma nova. **Casos de uso:** - Auditoria: identificar chaves expiradas, inativas ou criadas por ex-funcionários - Inventário: tela de gestão de credenciais no portal interno - Compliance: relatórios de quem tem acesso à API e desde quando **Filtros úteis:** use `searchText` para buscar por substring no nome (ex.: `searchText=ERP` lista todas com "ERP" no nome). Combine com `pagina` e `limite` (paginação padrão Pontua, ver [Paginação](/conceitos/paginacao)). ## OpenAPI ````yaml https://api.pre.pontua.tech/api/public/doc-json get /api-key openapi: 3.0.0 info: title: Pontua Public API description: >- API oficial da Pontua para integrações de clientes externos. Autentique com o token gerado no dashboard em **Configurações → API**. Envie o token no header `Authorization: Bearer `. version: '1.0' contact: {} servers: [] security: [] tags: [] paths: /api-key: get: tags: - Api Keys summary: Lista as API Keys da unidade de negócio description: >- Lista todas as chaves de API criadas na unidade de negócio do usuário autenticado, com paginação padrão. **O que retorna:** apenas **metadata** (`apiKeyId`, `name`, `isActive`, datas, `createdBy`). **Nunca** retorna o token bruto — esse só aparece uma vez, no momento da criação. Se você perdeu o token, **revogue a chave** (`PATCH /api-key/:id` com `isActive: false`) e crie uma nova. **Casos de uso:** - Auditoria: identificar chaves expiradas, inativas ou criadas por ex-funcionários - Inventário: tela de gestão de credenciais no portal interno - Compliance: relatórios de quem tem acesso à API e desde quando **Filtros úteis:** use `searchText` para buscar por substring no nome (ex.: `searchText=ERP` lista todas com "ERP" no nome). Combine com `pagina` e `limite` (paginação padrão Pontua, ver [Paginação](/conceitos/paginacao)). operationId: ApiKeysController_List parameters: - name: searchText description: Texto pesquisado para filtrar consulta required: false in: query schema: type: string - name: pagina description: Página que deseja retornar os resultados required: false in: query schema: example: 0 type: number - name: limite description: Quantidade de itens que retorna na consulta. Min 1 - Max 100 required: false in: query schema: example: 100 type: number responses: '200': description: Lista paginada de chaves com metadata (sem o token bruto) content: application/json: schema: $ref: '#/components/schemas/ApiKeysListDto' default: description: "\n\t\t\t400 - Bad Request: A solicitação não está no formato correto.\n\t\t\t401 - Unauthorized: A solicitação não foi autorizada. Verifique se o token de acesso é válido.\n\t\t\t403 - Forbidden: Acesso proibido! Requer um nível de permissão mais elevado.\n\t\t\t404 - Not Found: O recurso solicitado não foi encontrado.\n\t\t\t500 - Internal Server Error: Erro de execução no servidor!\n\t\t\t" content: application/json: schema: $ref: '#/components/schemas/ErrorDto' deprecated: false security: - bearer: [] components: schemas: ApiKeysListDto: type: object properties: pagina: type: number description: Pagina que deseja retornar os resultados example: 0 limite: type: number description: Quantidade de itens que retorna na consulta. Min 1 - Max 100 example: 25 total: type: number description: Total de registros encontrados example: 100 items: description: >- Lista de chaves desta página de resultados (apenas metadata, sem o token bruto). type: array items: $ref: '#/components/schemas/ApiKeyDto' required: - total - items ErrorDto: type: object properties: service: type: string description: Rota solicitada method: type: string description: Método http message: description: Mensagem do erro oneOf: - type: string example: message erro - type: array items: type: string example: - erro 1 - erro 2 required: - service - method - message ApiKeyDto: type: object properties: name: type: string description: Nome amigável da chave, definido na criação. example: Sync ERP Domínio - Produção apiKeyId: type: string description: >- Identificador único da chave (UUID). Use em PATCH para atualizar/revogar a chave. Não confundir com o token bruto — este nunca aparece em listagens. example: cm8f3k2x10001abcd1234efgh isActive: type: boolean description: >- Indica se a chave está ativa. `false` significa revogada (manualmente via PATCH ou expirada). Chamadas com chave inativa falham com 401. example: true createdAt: format: date-time type: string description: Data de criação da chave (ISO 8601 UTC). example: '2026-04-27T13:00:00.000Z' updatedAt: format: date-time type: string description: Data da última atualização de metadados (nome ou status). example: '2026-04-27T13:00:00.000Z' expiresAt: format: date-time type: string description: >- Data de expiração calculada na criação a partir de `expiresIn`. Após esta data, qualquer chamada falha com 401 — não há renovação, apenas criação de nova chave. example: '2027-04-27T13:00:00.000Z' deactivatedAt: format: date-time type: string description: >- Data em que a chave foi revogada manualmente (PATCH `isActive: false`). Nulo se a chave nunca foi desativada. example: '2026-04-27T13:00:00.000Z' createdBy: type: object description: >- Usuário autenticado que criou a chave. Toda chamada feita com a chave fica auditável a este usuário, mesmo após desligamento. example: name: Douglas Coelho nickname: DOU.01 required: - name - apiKeyId - isActive - createdAt - updatedAt - expiresAt - createdBy ````