Skip to main content
GET
/
api-keys
{
  "api_keys": [
    {
      "id": 1,
      "api_key_id": "ak_1234567890abcdef",
      "name": "Minha API Key",
      "permissions": [
        "read:emails",
        "write:emails"
      ],
      "is_active": true,
      "last_used_at": "2025-01-21T16:30:00Z",
      "expires_at": "2025-12-31T23:59:59Z",
      "created_at": "2025-01-21T16:30:00Z",
      "updated_at": "2025-01-21T16:30:00Z",
      "user_id": "user_123",
      "domain_name": 1
    }
  ],
  "total": 10,
  "page": 1,
  "limit": 50
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page
integer
default:1

Número da página

Required range: x >= 1
limit
integer
default:50

Itens por página

Required range: 1 <= x <= 100
name
string | null

Filtrar por nome

is_active
boolean | null

Filtrar por status ativo

domain_name
integer | null

Filtrar por domínio

permission
enum<string> | null

Filtrar por permissão

Available options:
read:emails,
write:emails,
read:webhooks,
write:webhooks,
read:stats,
read:suppressions,
write:suppressions,
admin

Response

Lista de API Keys retornada com sucesso

Modelo de resposta para listagem de API Keys

api_keys
ApiKeyResponse · object[]
required

Lista de API Keys

total
integer
required

Total de API Keys

Example:

10

page
integer
required

Página atual

Example:

1

limit
integer
required

Itens por página

Example:

50