Ver .md

admin.waitlist.list

Lista a lista de espera. Até 200 e-mails da lista de espera, mais recentes primeiro. q filtra por trecho do e-mail; status pelo estado do convite.

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

Entrada

CampoTipoObrigatórioNota
qstringnão
status"aguardando" | "convidado" | "expirado" | "cadastrado"não
JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "q": {
      "type": "string",
      "maxLength": 120
    },
    "status": {
      "type": "string",
      "enum": [
        "aguardando",
        "convidado",
        "expirado",
        "cadastrado"
      ]
    }
  }
}

Exemplo

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

CLI:

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

MCP: ferramenta admin_waitlist_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"
      },
      "email": {
        "type": "string"
      },
      "request": {
        "type": [
          "string",
          "null"
        ]
      },
      "source": {
        "type": "string"
      },
      "createdAt": {
        "type": "string"
      },
      "invitedAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "inviteExpiresAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "signedUpAt": {
        "type": [
          "string",
          "null"
        ]
      },
      "status": {
        "type": "string",
        "enum": [
          "aguardando",
          "convidado",
          "expirado",
          "cadastrado"
        ]
      }
    },
    "required": [
      "id",
      "email",
      "request",
      "source",
      "createdAt",
      "invitedAt",
      "inviteExpiresAt",
      "signedUpAt",
      "status"
    ],
    "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).