# Listar chaves

Fonte: https://apiwpp.com/docs/api/chaves-de-api/listar-chaves
Seção: Chaves de API
Atualizado em: 2026-09-28

`GET /tenants/{id}/api-keys`

Lista as chaves do projeto, das mais novas para as mais antigas: todas as que ainda funcionam e as 100 revogadas ou expiradas mais recentes, para auditoria. Nunca devolve as chaves em si, só o prefixo e a versão mascarada. Escopo necessário: `keys:read`.

## Cabeçalhos

| Nome | Obrigatório | Descrição |
| --- | --- | --- |
| `Authorization` | sim | `Bearer <chave de API>`; ou envie a chave em `X-Api-Key`. |

## Parâmetros de caminho

| Nome | Tipo | Obrigatório | Descrição |
| --- | --- | --- | --- |
| `id` | `string · uuid` | sim | Identificador do projeto (`tenantId`) cujas chaves você quer listar. |

## Exemplo de requisição

### cURL

```bash
curl https://api.apiwpp.com/tenants/$TENANT_ID/api-keys \
  -H "Authorization: Bearer $API_KEY"
```

### Node.js

```javascript
const res = await fetch(`https://api.apiwpp.com/tenants/${tenantId}/api-keys`, {
  headers: {
    Authorization: `Bearer ${API_KEY}`,
  },
})
const data = await res.json()
```

### PHP

```php
$response = Http::withToken($apiKey)
    ->get("https://api.apiwpp.com/tenants/{$tenantId}/api-keys");
```

### Python

```python
import requests

response = requests.get(
    f"https://api.apiwpp.com/tenants/{tenant_id}/api-keys",
    headers={"Authorization": f"Bearer {API_KEY}"},
)
```

## Respostas

| Código | Erro | Descrição |
| --- | --- | --- |
| 200 |  | `apiKeys` (as chaves, das mais novas para as mais antigas) e `count` (quantas vieram). Cada chave traz `id`, `tenantId` (o projeto), `organizationId` (a organização do projeto), `name`, `prefix` (identifica a chave; não é secreto), `maskedKey` (`wag_live_<prefixo>_…`, para reconhecer a chave), `scopes`, `status` (`active`, `expired` ou `revoked`), `createdBy` (`apiKey:<id>` da chave que a criou, `user:<id>` do usuário do painel ou `platform`), `createdAt`, `lastUsedAt` (atualizado no máximo uma vez por minuto), `expiresAt`, `revokedAt` e `rotatedAt` (quando uma rotação a substituiu). |
| 400 | `FST_ERR_VALIDATION` | Um parâmetro de caminho não é um UUID; `message` diz qual. |
| 401 |  | Sem chave de API, ou com uma chave inválida: desconhecida, revogada, expirada ou de um projeto desativado. O corpo é `{"error": "Unauthorized"}`. |
| 403 |  | A credencial não tem o escopo `keys:read`; a mensagem cita o escopo (`This credential lacks the keys:read scope`). |
| 404 |  | O projeto não existe ou não é de quem chama (`Tenant not found`): uma chave de API alcança só o próprio projeto, e o de outra pessoa responde igual a um que não existe. |
| 429 |  | Requisições demais deste IP de origem (por padrão, 600 por minuto), ou autenticações com falha demais (por padrão, 20 a cada 5 minutos): espere os segundos de `Retry-After`. Veja [Limites](https://apiwpp.com/docs/referencia/limites). Cabeçalhos: `Retry-After`. |

### 200 OK

```json
{
  "apiKeys": [
    {
      "id": "5e8f1a2b-3c4d-4e5f-8a9b-0c1d2e3f4a5b",
      "tenantId": "3f6c2a8e-9d41-4b7a-8c15-2e7d9a0b4c61",
      "organizationId": "2d5e8a1b-4c7f-4e9a-8b3d-6f0a2c4e8b1d",
      "name": "CRM produção",
      "prefix": "k3x9p2ab",
      "maskedKey": "wag_live_k3x9p2ab_…",
      "scopes": [
        "connections:read",
        "messages:send"
      ],
      "status": "active",
      "createdBy": "platform",
      "createdAt": "2026-09-01T12:00:00.000Z",
      "lastUsedAt": "2026-09-24T12:00:00.000Z",
      "expiresAt": null,
      "revokedAt": null,
      "rotatedAt": null
    }
  ],
  "count": 1
}
```

## Detalhes

Uma chave de API lista só as chaves do próprio projeto. No painel, qualquer membro da organização vê as chaves; só donos e administradores as criam, rotacionam e revogam.

Uma chave rotacionada aparece com `rotatedAt` preenchido e continua `active` até o `expiresAt` que a rotação definiu; depois disso ela passa a `expired`.

Guia: [Autenticação](https://apiwpp.com/docs/autenticacao).
