AtomiksAPI
Ver .md

api_keys.list

Listar chaves de API da conta. Lista as chaves de API da conta atual (prefixo, escopos, último uso e revogação). A chave completa nunca é devolvida aqui.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/api_keys.list (corpo JSON)
  • Quem pode chamar: administrador da conta
  • Escopo da chave: nenhum (qualquer chave serve)
  • Grava dados: não
  • Pela chave de API: não (só pela interface)
  • Ferramenta MCP: não
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId api_keys.list)

Entrada

Sem campos: envie {}.

JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {}
}

Exemplo

curl -X POST https://app.atomiks.com.br/api/v1/api_keys.list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

Saída

Sucesso: {"data": ...} com o formato abaixo.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "id": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "prefix": {
        "type": "string"
      },
      "scopes": {
        "type": "array",
        "items": {
          "type": "string",
          "enum": [
            "account:read",
            "account:write",
            "team:read",
            "team:write",
            "activity:read",
            "admin:read",
            "admin:write",
            "channels:read",
            "channels:write",
            "contacts:read",
            "ads:read",
            "ads:write",
            "messages:read",
            "messages:send",
            "messages:manage",
            "crm:read",
            "crm:write",
            "conversions:read",
            "conversions:write",
            "automations:read",
            "automations:write",
            "marketing:read",
            "marketing:write"
          ]
        }
      },
      "lastUsedAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "createdAt": {
        "type": "string"
      },
      "revokedAt": {
        "type": [
          "string",
          "null"
        ]
      }
    },
    "required": [
      "id",
      "name",
      "prefix",
      "scopes",
      "lastUsedAt",
      "createdAt",
      "revokedAt"
    ],
    "additionalProperties": false
  }
}

Erros

{"error": {"code", "message", "requestId"}}. Códigos: invalid_input (400), unauthorized (401), forbidden / account_pending / scope_missing (403), not_found (404), limit_reached (409), internal (500).