---
title: "Onboarding state"
method: GET
path: "/api/onboarding"
tags: ["v1", "onboarding"]
---

# Onboarding state

`GET /api/onboarding`

## Response `200`

Successful Response

- UserOnboarding
  - `userId` string, required
  - `completedSteps` OnboardingStep[], required
  - `walletShown` boolean, required
  - `notified` OnboardingStep[], required
  - `rewardedFor` OnboardingStep[], required
  - `usageReason` string, nullable, required
  - `integrations` string[], required
  - `otherIntegrations` string, nullable, required
  - `selectedStoreListingVersionId` string, nullable, required
  - `agentInput` object, nullable, required
  - `onboardingAgentExecutionId` string, nullable, required
  - `agentRuns` integer, required
  - `lastRunAt` string, date-time, nullable, required
  - `consecutiveRunDays` integer, required

## Other responses

- `401` — Authentication required

## Changes

- **2026-08-10** `c5d87f954859` — 9 warning
  - added the new `AGENTS_TAB_INTRO` enum value to the `completedSteps/items/` response property for the response status `200`
  - added the new `AGENTS_TAB_INTRO` enum value to the `notified/items/` response property for the response status `200`
  - added the new `AGENTS_TAB_INTRO` enum value to the `rewardedFor/items/` response property for the response status `200`
  - added the new `BUILD_TAB_INTRO` enum value to the `completedSteps/items/` response property for the response status `200`
  - …5 more
- **2026-08-07** `c81533fee655` — 6 warning, 6 info
  - added the new `LIBRARY_RUN_AGENT` enum value to the `completedSteps/items/` response property for the response status `200`
  - added the new `LIBRARY_RUN_AGENT` enum value to the `notified/items/` response property for the response status `200`
  - added the new `LIBRARY_RUN_AGENT` enum value to the `rewardedFor/items/` response property for the response status `200`
  - added the new `ONBOARDING_COMPLETE` enum value to the `completedSteps/items/` response property for the response status `200`
  - …8 more
- …earlier changes not shown

[Full history](https://skmtc.dev/significant-gravitas/apis/autogpt-agent-server/changes/api/onboarding/get.md)

---

[API](https://skmtc.dev/significant-gravitas/apis/autogpt-agent-server.md) · [All operations](https://skmtc.dev/significant-gravitas/apis/autogpt-agent-server/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/significant-gravitas/autogpt-agent-server/revisions/5dc375899754/schema)