AtomiksAPI
Ver .md

admin.plans.list

Lista planos. Lista os planos com módulos liberados e limites.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/admin.plans.list (corpo JSON)
  • Quem pode chamar: super-admin da plataforma
  • Escopo da chave: admin:read
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: admin_plans_list
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId admin.plans.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/admin.plans.list \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs admin.plans.list --json '{}'

MCP: ferramenta admin_plans_list com a mesma entrada.

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"
      },
      "key": {
        "type": "string"
      },
      "name": {
        "type": "string"
      },
      "isFree": {
        "type": "boolean"
      },
      "modules": {
        "type": "array",
        "items": {
          "type": "string"
        }
      },
      "limits": {
        "type": "object",
        "properties": {
          "users": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "channels": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "contacts": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          },
          "mediaRetentionDays": {
            "type": "integer",
            "minimum": 0,
            "maximum": 9007199254740991
          }
        },
        "required": [
          "users",
          "channels",
          "contacts",
          "mediaRetentionDays"
        ],
        "additionalProperties": false
      },
      "accounts": {
        "type": "integer",
        "minimum": -9007199254740991,
        "maximum": 9007199254740991
      }
    },
    "required": [
      "id",
      "key",
      "name",
      "isFree",
      "modules",
      "limits"
    ],
    "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).