API by router
Onboarding
POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
message*Messageonboarding_completed?Onboarding CompletedDefault
truecurl -X POST 'https://example.com/v1/onboarding/complete'Example Response
{ "message": "string", "onboarding_completed": true}POST
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullapplication/json- body
Step 1: Organisation details.
company_name*Company NameLength
1 <= length <= 200industry?|nullSuccessful Response
application/json- response
Current onboarding state for the authenticated user's customer.
company_name?string|nullindustry?string|nullonboarding_completed*Onboarding Completedsubscription_status?string|nulltier_name?string|nulltrial_ends_at?string|nullcurl -X POST 'https://example.com/v1/onboarding/setup' \ -H 'Content-Type: application/json' \ -d '{ "company_name": "string"}'Example Response
{ "company_name": "string", "industry": "string", "onboarding_completed": true, "subscription_status": "string", "tier_name": "string", "trial_ends_at": "string"}GET
HTTPBearerheader
AuthorizationBearer <token>X-Api-Key?string|nullSuccessful Response
application/json- response
Current onboarding state for the authenticated user's customer.
company_name?string|nullindustry?string|nullonboarding_completed*Onboarding Completedsubscription_status?string|nulltier_name?string|nulltrial_ends_at?string|nullcurl -X GET 'https://example.com/v1/onboarding/status'Example Response
{ "company_name": "string", "industry": "string", "onboarding_completed": true, "subscription_status": "string", "tier_name": "string", "trial_ends_at": "string"}