getting_started.get
Ver Configurações › Primeiros passos. Estado da tela Primeiros passos para o próprio usuário na conta atual: hidden (o usuário escondeu o checklist; mesma preferência de onboarding.dismiss) e milestones, o mapa marco → feito dos marcos que têm equivalente no Atomiks (produto, oferta, WhatsApp conectado, automação, pipeline, oportunidade, primeira venda). Marco que não vem no mapa ainda não existe no Atomiks.
- Endpoint:
POST https://app.atomiks.com.br/api/v1/getting_started.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:
getting_started_get - Ficha em JSON:
https://app.atomiks.com.br/api/v1/openapi.json(operationIdgetting_started.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/getting_started.get \
-H "Authorization: Bearer $ATOMIKS_API_KEY" \
-H "Content-Type: application/json" \
-d '{}'CLI:
node cli/atomiks.mjs getting_started.get --json '{}'MCP: ferramenta getting_started_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": {
"hidden": {
"type": "boolean"
},
"milestones": {
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "boolean"
}
}
},
"required": [
"hidden",
"milestones"
],
"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).