---
title: "Get current onboarding state from session"
method: GET
path: "/api/auth/onboarding-state"
tags: ["auth", "internal"]
---

# Get current onboarding state from session

`GET /api/auth/onboarding-state`

## Response `200`

Onboarding state

- ApiResponseOnboardingStateResponse
  - `data` object — Response from onboarding state endpoint
    - `network` OnboardingNetworkState — Network data in onboarding state response
      - `id` string, uuid, nullable — Network ID (if created)
      - `name` string, required — Network name
    - `network_id` string, uuid, nullable — Network ID from pending setup (if any)
    - `org_name` string, nullable — Organization name from pending setup
    - `step` string, nullable — Current onboarding step (if any)
    - `use_case` 'homelab' | 'internal_it' | 'msp' | 'other'
  - `error` string, nullable — Human-readable failure message. Omitted on success.
  - `meta` ApiMeta, required — API metadata included in all responses
    - `api_version` integer, required — API version (integer, increments on breaking changes)
    - `server_version` string, required — Server version (semver)
  - `success` boolean, required — `true` when the request succeeded. `false` responses carry `error` instead of `data`.

---

[API](https://skmtc.net/scanopy/apis/scanopy-api.md) · [All operations](https://skmtc.net/scanopy/apis/scanopy-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scanopy/scanopy-api/revisions/2df1fc47dfa7/schema)