---
title: "Get Onboarding Guide State"
method: GET
path: "/v1/preferences/onboarding/{guide_key}"
tags: ["preferences"]
---

# Get Onboarding Guide State

`GET /v1/preferences/onboarding/{guide_key}`

Return whether an onboarding guide may auto-start for this user/workspace.

## Path parameters

- `guide_key` string, required

## Query parameters

- `workspace_id` string, uuid, required

## Response `200`

Successful Response

- OnboardingGuideStateOut
  - `guide_key` string, required
  - `workspace_id` string, uuid, required
  - `status` 'not_started' | 'auto_started' | 'completed' | 'skipped', required
  - `auto_start_allowed` boolean, required
  - `first_auto_started_at` string, date-time, nullable
  - `last_started_at` string, date-time, nullable
  - `completed_at` string, date-time, nullable
  - `skipped_at` string, date-time, nullable

## Other responses

- `422` — Validation Error

---

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