Onboarding

Get onboarding state

GET /api/v1/onboarding

Returns onboarding progress for the specified app (defaults to biz-mobile).

Parameters

Name	In	Type	Required	Description
`app`	query	`string`	no	Application ID (e.g. `biz-mobile`, `webapp`). Defaults to `biz-mobile`.

Responses

200 — The onboarding state. UserOnboarding
401 — Missing or invalid credential (session token or API key; only when auth is configured). Error

curl "$API_URL/api/v1/onboarding" \
  -H "Authorization: Bearer $TOKEN"

PUT /api/v1/onboarding

Updates onboarding progress, steps completed/skipped, and overall completion status.

Request body (application/json)

Responses

200 — Saved. object
400 — Malformed onboarding payload. Error
401 — Missing or invalid credential (session token or API key; only when auth is configured). Error

curl -X PUT "$API_URL/api/v1/onboarding" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ ... }'

Per-user onboarding progress and completion status per app.

Field	Type	Required	Description
`userId`	`string`	yes
`appId`	`string`	yes
`isCompleted`	`boolean`	yes
`completedAt`	`string` \| `null`	no
`done`	`string`[]	yes
`skipped`	`string`[]	yes
`method`	`"agent"` \| `"manual"` \| `null`	yes	How the user chose to onboard; null when not chosen yet.
`updatedAt`	`string`	yes

Field	Type	Required	Description
`error`	`string`	yes

Payload to update user onboarding progress.

Field	Type	Required	Description
`appId`	`string`	no
`isCompleted`	`boolean`	no
`done`	`string`[]	no
`skipped`	`string`[]	no
`method`	`"agent"` \| `"manual"` \| `null`	no	Pass `null` to clear the stored method.