---
title: "Get onboarding paths, steps, and fields"
method: GET
path: "/api/onboarding/schema"
tags: ["Onboarding"]
---

# Get onboarding paths, steps, and fields

`GET /api/onboarding/schema`

Returns every onboarding path in `allPaths`, plus the active path-specific step list when the optional `path` query parameter is supplied.

## 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.

## Response `200`

Onboarding schema payload.

- object
  - `data` OnboardingSchema, required
    - `paths` OnboardingPathChoice[], required
      - `id` 'prescriber' | 'developer' | 'clinic' | 'enterprise' | 'platform' | 'other', required — Public onboarding path id. Prefer `/onboard?type={id}` for new human links. Legacy `/onboard#{id}` and `/onboard#{id}-{payment_plan_tier}` links remain supported.
      - `label` string, required
      - `description` string, required
      - `cta` string, required
      - `mode` 'self_serve' | 'verification_required' | 'sales_led', required
    - `allPaths` OnboardingFullPath[], required
      - `id` 'prescriber' | 'developer' | 'clinic' | 'enterprise' | 'platform' | 'other', required — Public onboarding path id. Prefer `/onboard?type={id}` for new human links. Legacy `/onboard#{id}` and `/onboard#{id}-{payment_plan_tier}` links remain supported.
      - `label` string, required
      - `description` string, required
      - `cta` string, required
      - `mode` 'self_serve' | 'verification_required' | 'sales_led', required
      - `provisioningMode` 'developer' | 'prescriber' | 'handoff', required
      - `entryPath` string, required
      - `steps` OnboardingStep[], required
        - `id` string, required
        - `title` string, required
        - `fields` OnboardingField[], required
          - `name` string, required
          - `label` string, required
          - `type` 'email' | 'multi-select' | 'radio-cards' | 'select' | 'tel' | 'text' | 'textarea' | 'url', required
          - `required` boolean
          - `options` union[]
            - union
              - …
          - `placeholder` string
          - `autoComplete` string
          - `inputMode` string
          - `showWhen` object
            - `field` string
            - `value` string
    - `path` 'prescriber' | 'developer' | 'clinic' | 'enterprise' | 'platform' | 'other', required — Public onboarding path id. Prefer `/onboard?type={id}` for new human links. Legacy `/onboard#{id}` and `/onboard#{id}-{payment_plan_tier}` links remain supported.
    - `steps` OnboardingStep[], required
      - `id` string, required
      - `title` string, required
      - `fields` OnboardingField[], required
        - `name` string, required
        - `label` string, required
        - `type` 'email' | 'multi-select' | 'radio-cards' | 'select' | 'tel' | 'text' | 'textarea' | 'url', required
        - `required` boolean
        - `options` union[]
          - union
            - string
            - OnboardingPathChoice
              - …
        - `placeholder` string
        - `autoComplete` string
        - `inputMode` string
        - `showWhen` object
          - `field` string
          - `value` string

---

[API](https://skmtc.dev/photon/apis/photon-website-api.md) · [All operations](https://skmtc.dev/photon/apis/photon-website-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/photon/photon-website-api/revisions/ab555c915b80/schema)