---
title: "Get onboarding status"
method: GET
path: "/v1/claude/onboarding/status"
tags: ["claude"]
---

# Get onboarding status

`GET /v1/claude/onboarding/status`

Returns the current state of the onboarding process

## Query parameters

- `include_output` boolean

## Response `200`

OK

- GithubComVanpeltCatnipInternalModelsClaudeOnboardingStatus — Status of the automated Claude Code onboarding/login flow
  - `error_message` string — Error message if state is 'error'
  - `message` string — Human-readable message about the current state
  - `oauth_url` string — OAuth URL for authentication (only present in auth_url and auth_waiting states)
  - `output` string — Full PTY output buffer for debugging (only included if requested)
  - `state` 'idle' | 'theme_select' | 'auth_method' | 'auth_url' | 'auth_waiting' | 'auth_confirm' | 'security_notes' | 'terminal_setup' | 'complete' | 'error' — Current state in the onboarding flow

---

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