v1
latestOpenAPI 3.1.02026-07-1382036.1 KBOnboarding
Get onboarding paths, steps, and fields
Returns every onboarding path in allPaths, plus the active path-specific step list when the optional path query parameter is supplied.
get/api/onboarding/schema
Query parameters
path'prescriber' | 'developer' | 'clinic' | 'enterprise' | 'platform' | 'other'
Public onboarding path id. Prefer /onboard?type={id} for new human links. Legacy /onboard#{id} and /onboard#{id}-{payment_plan_tier} links remain supported.
Optional onboarding path id used to return the currently active step list.
Response
Onboarding schema payload.