Obter os próximos passos
RegistosGET /next-steps
Returns the next one to three actionable steps for the signed-in utility user and their tenant, chosen and ordered by the server from progress, review state, capabilities, counts and connectors; an empty list when nothing is waiting. Each step has a stable ID, localized title and line (saved language, then Accept-Language, then the platform default), the role that acts, a portable action ID the client maps to its own screen, and a help article ID from the shared help registry. Clients keep no step list or order of their own. GET is safe to retry and completes nothing. Requires business:onboarding:read for the utility owner and admins (test-account tour, then the real-account checklist). A field reader, cashier or finance user without that scope gets their own role's first-run step, authorized by the entitlement of that action; the role comes from the principal's assigned roles.
Parâmetros
X-First-Run-TokenOpaque run token from an earlier progress or next-steps response. It joins this request's first-use events to one run and carries no identity.
Devolve
200 Next steps
Mostrar atributos
audienceum de
platform,business,consumer,residentlocaleum de
pt-MZ,en-USgenerated_atstepsMostrar atributos filhos
idjourney_idtitlelinestateum de
todo,blockedownerum de
you,platform_review,team_member,utility_owneractionMostrar atributos filhos
idPortable destination intent each client maps to its own screen
labelLocalized action label
routeIn-app route on the platform dashboard (platform setup only)
helpMostrar atributos filhos
article_idHelp registry category/slug
blocked_reasonMostrar atributos filhos
codemessage
wait_lineOptional, localized like line. On the utility's review step (documents) until approval: how long the platform's review usually takes. Present only when the server has a figure: the median of past decided reviews once there are at least 3, else the configured onboarding.review_wait (default 0, meaning absent).
doorsThe two resident entry doors (public entry only)
Mostrar atributos filhos
idtitlelinehelpMostrar atributos filhos
article_id
actionsPublic utility lookup and request-status actions (public entry only)
Mostrar atributos filhos
idtitlelinehelpMostrar atributos filhos
article_id
run_tokenOpaque run token for a staff journey or the anonymous resident entry
curl -X GET "$BUSINESS_API/next-steps" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/next-steps", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/next-steps",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/next-steps", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"audience": "platform",
"locale": "pt-MZ",
"generated_at": "2026-11-19T09:30:00Z",
"steps": [
{
"id": "customer_import",
"journey_id": "utility_real",
"title": "Fuga na Rua 3",
"line": "line",
"state": "todo",
"owner": "you",
"action": {
"id": "utility.real.customer_import",
"label": "label",
"route": "/platform/settings/branding"
},
"help": {
"article_id": "getting-started/import-customers"
},
"blocked_reason": {
"code": "review_pending",
"message": "Leitura confirmada no local."
},
"wait_line": "A revisão costuma demorar cerca de 2 dias."
}
],
"doors": [
{
"id": "resident.link-existing-account",
"title": "Fuga na Rua 3",
"line": "line",
"help": {
"article_id": "residents/link-resident-account"
}
}
],
"actions": [
{
"id": "resident.link-existing-account",
"title": "Fuga na Rua 3",
"line": "line",
"help": {
"article_id": "residents/link-resident-account"
}
}
],
"run_token": "run token"
}