AtomiksAPI
Ver .md

onboarding.get

Ver meus primeiros passos. Checklist "Primeiros passos" da conta atual para o próprio usuário: grupos com passos marcados sozinhos pelo que já existe na conta (número conectado, conta de anúncios, contatos, venda...). Passos de telas que o usuário não acessa ficam de fora. dismissed: o usuário pulou o checklist nesta conta.

  • Endpoint: POST https://app.atomiks.com.br/api/v1/onboarding.get (corpo JSON)
  • Quem pode chamar: membro da conta
  • Escopo da chave: nenhum (qualquer chave serve)
  • Grava dados: não
  • Pela chave de API: sim
  • Ferramenta MCP: onboarding_get
  • Ficha em JSON: https://app.atomiks.com.br/api/v1/openapi.json (operationId onboarding.get)

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/onboarding.get \
  -H "Authorization: Bearer $ATOMIKS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

CLI:

node cli/atomiks.mjs onboarding.get --json '{}'

MCP: ferramenta onboarding_get com a mesma entrada.

Saída

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

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "groups": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "key": {
            "type": "string"
          },
          "title": {
            "type": "string"
          },
          "steps": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "key": {
                  "type": "string"
                },
                "title": {
                  "type": "string"
                },
                "description": {
                  "type": "string"
                },
                "href": {
                  "type": "string"
                },
                "done": {
                  "type": "boolean"
                }
              },
              "required": [
                "key",
                "title",
                "description",
                "href",
                "done"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "key",
          "title",
          "steps"
        ],
        "additionalProperties": false
      }
    },
    "done": {
      "type": "number"
    },
    "total": {
      "type": "number"
    },
    "dismissed": {
      "type": "boolean"
    }
  },
  "required": [
    "groups",
    "done",
    "total",
    "dismissed"
  ],
  "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).