admin.accounts.list

Lista contas (gestão). Lista contas com dono, plano, status (pending, active ou blocked), número de membros, canais de WhatsApp conectados, hora do último webhook recebido e datas. status aceita pending, active ou all; contas bloqueadas (plano gratuito já ativado antes) só aparecem em all. plano filtra pela chave do plano, inativas por dias sem atividade (sem atividade, conta desde a criação) e canal: problema por contas com canal parado ou que nunca recebeu evento (channelsAttention), canal: sem por contas sem canal conectado, includeTest inclui as contas de teste (dono @test.atomiks.dev), escondidas por padrão, e limite (percentual, ex. 80) por contas com membros ou canais a esse percentual ou mais do limite do plano. Nunca retorna conteúdo.

• Endpoint: POST https://app.atomiks.com.br/api/v1/admin.accounts.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_accounts_list
• Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId admin.accounts.list)

Entrada

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "status": {
      "type": "string",
      "enum": [
        "pending",
        "active",
        "all"
      ]
    },
    "q": {
      "type": "string"
    },
    "plano": {
      "type": "string"
    },
    "inativas": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "canal": {
      "type": "string",
      "enum": [
        "problema",
        "sem"
      ]
    },
    "limite": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100
    },
    "includeTest": {
      "type": "boolean"
    }
  }
}

Exemplo

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

CLI:

node cli/atomiks.mjs admin.accounts.list --json '{"status":"all"}'

MCP: ferramenta admin_accounts_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"
      },
      "name": {
        "type": "string"
      },
      "owner": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "email": {
            "type": "string"
          }
        },
        "required": [
          "name",
          "email"
        ],
        "additionalProperties": false
      },
      "plan": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "name": {
            "type": "string"
          }
        },
        "required": [
          "key",
          "name"
        ],
        "additionalProperties": false
      },
      "status": {
        "type": "string",
        "enum": [
          "pending",
          "active",
          "blocked"
        ]
      },
      "members": {
        "type": "number"
      },
      "channels": {
        "type": "number"
      },
      "lastWebhookAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "createdAt": {
        "type": "string"
      },
      "activatedAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "lastActivityAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "purgeAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "channelsAttention": {
        "type": "number"
      },
      "nearLimit": {
        "type": "number"
      }
    },
    "required": [
      "id",
      "name",
      "owner",
      "plan",
      "status",
      "members",
      "channels",
      "lastWebhookAt",
      "createdAt",
      "activatedAt",
      "lastActivityAt",
      "purgeAt",
      "channelsAttention",
      "nearLimit"
    ],
    "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).