Appearance
Onboarding API
5 operations. Paths are relative to the API host (http://localhost:5080 in local development). Every operation accepts an OIDC bearer token (Authorization: Bearer …) or a workspace API key (X-Api-Key: keel_live_…); errors are RFC 9457 Problem Details with a code (error codes). Permissions: matrix.
| Method | Path | Summary |
|---|---|---|
| GET | /api/v1/onboarding | The caller's first-run wizard in the current tenant (status None when they have none). |
| PUT | /api/v1/onboarding | Save the wizard step and answers (resumes at the same step, F21 AC2). |
| POST | /api/v1/onboarding:complete | Finish the wizard (audited). |
| POST | /api/v1/onboarding:skip | Skip the wizard; the getting-started checklist stays on Home. |
| POST | /api/v1/onboarding/checklist:dismiss | Hide the getting-started checklist on Home for the caller. |
GetOnboarding
http
GET /api/v1/onboardingThe caller's first-run wizard in the current tenant (status None when they have none).
| Status | Description | Body |
|---|---|---|
| 200 | OK | OnboardingDto |
Response 200: OnboardingDto
| Field | Type | Notes |
|---|---|---|
checklistDismissed | boolean | |
dataChoice | string? | |
finishedAt | date-time? | |
goals | string[] | |
jobRole | string? | |
startedAt | date-time | |
status | string | |
step | int32 |
SaveOnboarding
http
PUT /api/v1/onboardingSave the wizard step and answers (resumes at the same step, F21 AC2).
Request body (application/json): SaveOnboardingRequest
| Field | Type | Notes |
|---|---|---|
dataChoice | string? | |
goals | string[]? | |
jobRole | string? | |
step | int32 |
| Status | Description | Body |
|---|---|---|
| 204 | No Content | — |
CompleteOnboarding
http
POST /api/v1/onboarding:completeFinish the wizard (audited).
Request body (application/json): CompleteOnboardingRequest
| Field | Type | Notes |
|---|---|---|
invitesSent | int32 |
| Status | Description | Body |
|---|---|---|
| 204 | No Content | — |
SkipOnboarding
http
POST /api/v1/onboarding:skipSkip the wizard; the getting-started checklist stays on Home.
| Status | Description | Body |
|---|---|---|
| 204 | No Content | — |
DismissGettingStarted
http
POST /api/v1/onboarding/checklist:dismissHide the getting-started checklist on Home for the caller.
| Status | Description | Body |
|---|---|---|
| 204 | No Content | — |