Read first-use progress for one journey
LogsGET /first-run/progress
Returns the durable progress of the signed-in resident for one journey (resident_link, resident_connection): every step by stable ID in server order, its state (todo, done, skipped or blocked with a reason), whether and why it can be skipped, who changed it and when, and the qualifying action that completed it. A journey with no record returns its steps as todo. The response also carries an opaque run token the client sends back in the X-First-Run-Token header so funnel events join without storing who ran them. Requires an authenticated resident.
Parameters
journeyJourney ID
one of
resident_link,resident_connectionX-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.
Returns
200 Journey progress
Show attributes
journey_idone of
platform_setup,utility_test,utility_real,resident_link,resident_connection,staff_field_reader,staff_cashier,staff_financesubjectWho changed a step, by actor type and stable user ID
Show child attributes
typeid
tenant_idThe utility for utility and staff journeys;
nullfor the platform journeyupdated_atstepsShow child attributes
idstateone of
todo,done,skipped,blockedcan_skipallowed_skip_reasonsreasonSkip reason code
changed_atchanged_byWho changed a step, by actor type and stable user ID
Show child attributes
typeid
completion_sourceThe qualifying domain action that completed the step
completed_atresponsibilityWho does the step on a checklist the platform sets up on a utility's behalf
one of
platform,utilitycompleted_byWho changed a step, by actor type and stable user ID
Show child attributes
typeid
run_tokenOpaque funnel run token; absent once the journey is complete
curl -X GET "$CONSUMER_API/first-run/progress" \
-H "Authorization: Bearer sk_test_..."
# No matching CLI command; use cURL or direct HTTP.
const res = await fetch("$CONSUMER_API/first-run/progress", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$CONSUMER_API/first-run/progress",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$CONSUMER_API/first-run/progress", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"journey_id": "platform_setup",
"subject": {
"type": "utility_staff",
"id": "usr_01"
},
"tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
"updated_at": "2026-11-19T09:30:00Z",
"steps": [
{
"id": "customer_import",
"state": "todo",
"can_skip": true,
"allowed_skip_reasons": [
"not_needed"
],
"reason": "Leitura confirmada no local.",
"changed_at": "2026-11-19T09:30:00Z",
"changed_by": {
"type": "utility_staff",
"id": "usr_01"
},
"completion_source": "service_area.created",
"completed_at": "2026-11-19T09:30:00Z",
"responsibility": "platform",
"completed_by": {
"type": "utility_staff",
"id": "usr_01"
}
}
],
"run_token": "run token"
}