Lista as API Keys da unidade de negócio

curl --request GET \
  --url https://api.example.com/api-key

{
  "total": 100,
  "items": [
    {
      "name": "Sync ERP Domínio - Produção",
      "apiKeyId": "cm8f3k2x10001abcd1234efgh",
      "isActive": true,
      "createdAt": "2026-04-27T13:00:00.000Z",
      "updatedAt": "2026-04-27T13:00:00.000Z",
      "expiresAt": "2027-04-27T13:00:00.000Z",
      "createdBy": {
        "name": "Douglas Coelho",
        "nickname": "DOU.01"
      },
      "deactivatedAt": "2026-04-27T13:00:00.000Z"
    }
  ],
  "pagina": 0,
  "limite": 25
}

Api Keys

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).

GET

api-key

Lista as API Keys da unidade de negócio

curl --request GET \
  --url https://api.example.com/api-key

{
  "total": 100,
  "items": [
    {
      "name": "Sync ERP Domínio - Produção",
      "apiKeyId": "cm8f3k2x10001abcd1234efgh",
      "isActive": true,
      "createdAt": "2026-04-27T13:00:00.000Z",
      "updatedAt": "2026-04-27T13:00:00.000Z",
      "expiresAt": "2027-04-27T13:00:00.000Z",
      "createdBy": {
        "name": "Douglas Coelho",
        "nickname": "DOU.01"
      },
      "deactivatedAt": "2026-04-27T13:00:00.000Z"
    }
  ],
  "pagina": 0,
  "limite": 25
}

Query Parameters

searchText

string

Texto pesquisado para filtrar consulta

pagina

number

Página que deseja retornar os resultados

Example:

0

limite

number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

100

Response

Lista paginada de chaves com metadata (sem o token bruto)

total

number

required

Total de registros encontrados

Example:

100

items

object[]

required

Lista de chaves desta página de resultados (apenas metadata, sem o token bruto).

Show child attributes

pagina

number

Pagina que deseja retornar os resultados

Example:

0

limite

number

Quantidade de itens que retorna na consulta. Min 1 - Max 100

Example:

25

Cria uma nova API Key