---
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
      - `snmp_community` string, nullable — SNMP community string
      - `snmp_enabled` boolean — Whether SNMP is enabled
      - `snmp_version` string, nullable — SNMP version
    - `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` string, nullable — Use case selection (homelab, company, msp)
  - `error` string, nullable
  - `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

## Changes

- **2026-04-20** `f04499e2280f` — 2 breaking, 4 info
  - the response property `data/use_case` became nullable for the status `200`
  - the `data/use_case` response's property type/format changed from ``/`` to `string, null`/`` for status `200`
  - added the optional property `data/network/oneOf[#/components/schemas/OnboardingNetworkState]/snmp_community` to the response with the `200` status
  - added the optional property `data/network/oneOf[#/components/schemas/OnboardingNetworkState]/snmp_enabled` to the response with the `200` status
  - …2 more

[Change history](https://skmtc.dev/scanopy/apis/scanopy-api/changes/api/auth/onboarding-state/get.md)

---

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