API by router
Onboarding
Complete Onboarding
Mark onboarding as done. Called when user finishes the wizard.
Requires account admin: completion flips org-wide state and setup requires admin, so completion can't be weaker.
"That'll do, pig. That'll do." — Farmer Hoggett, Babe
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X POST "https://loading/v1/onboarding/complete" \ -H "X-Api-Key: string"{
"message": "string",
"onboarding_completed": true
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Setup Organisation
Save organisation details (step 1 of onboarding).
Requires account admin (owner or admin team role).
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
company_nameCompany Name
Length
1 <= length <= 200industry?Industry
Response Body
curl -X POST "https://loading/v1/onboarding/setup" \ -H "X-Api-Key: string" \ -H "Content-Type: application/json" \ -d '{ "company_name": "string" }'{
"company_name": "string",
"industry": "string",
"onboarding_completed": true,
"subscription_status": "string",
"tier_name": "string",
"trial_ends_at": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}Get Onboarding Status
Check whether the current user has completed onboarding.
"Are we there yet?" — Every backseat passenger ever
AuthorizationBearer <token>
In: header
Header Parameters
X-Api-Key?X-Api-Key
Response Body
curl -X GET "https://loading/v1/onboarding/status" \ -H "X-Api-Key: string"{
"company_name": "string",
"industry": "string",
"onboarding_completed": true,
"subscription_status": "string",
"tier_name": "string",
"trial_ends_at": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string"
}
]
}