Onboarding API
API for user onboarding progress tracking and onboarding-related preferences. These endpoints support the multi-step onboarding wizard and the persistent "Getting Started" dashboard checklist.
Onboarding Progress
The Onboarding Progress endpoints are the source of truth for the checklist widget and wizard completion state. They track granular step-by-step progress and power the "Getting Started" dashboard widget.
Onboarding Preferences
The Preferences endpoint stores lightweight flags that need to be available
at login time (via AuthTokenResponse.preferences) without an extra API call.
Checklist Keys by Role
| Key | Admin | Manager | Creator | Asset Manager | User |
|---|---|---|---|---|---|
account_setup | yes | yes | yes | yes | yes |
video_transcodes_configured | yes | -- | -- | -- | -- |
schemas_added | yes | -- | -- | -- | -- |
team_member_invited | yes | -- | -- | -- | -- |
intro_videos_watched | -- | yes | yes | yes | yes |
first_asset_uploaded | yes | yes | yes | yes | -- |
first_collection_created | yes | yes | yes | yes | -- |
first_collection_browsed | -- | -- | -- | -- | yes |
first_share_created | yes | yes | yes | yes | yes |
Authentication
- HTTP: Bearer Auth
- API Key: ApiKeyAuth
JWT token obtained from POST /api/v1/login
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | bearer |
Bearer format: | JWT |
API key for programmatic access
Security Scheme Type: | apiKey |
|---|---|
Header parameter name: | X-FileSpin-Api-Key |