---
title: "Return the caller's Getting Started checklist state."
method: GET
path: "/api/v1/onboarding/setup"
tags: ["Onboarding"]
---

# Return the caller's Getting Started checklist state.

`GET /api/v1/onboarding/setup`

## Request

- Base URL: `https://api.avatarfactory.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.avatarfactory.io/api/v1/onboarding/setup`
- Auth: one of:
  - API key in cookie `session`
  - HTTP bearer

## Response `200`

OK

- SetupStatusResponse
  - `avatar` boolean, required
  - `complete` boolean, required
  - `done_count` integer, required
  - `followed` boolean, required
  - `onboarding` boolean, required
  - `steps` SetupStepItem[], required
    - `done` boolean, required
    - `key` string, required
    - `locked` boolean
    - `required_plan` string, nullable
    - `required_plan_name` string, nullable
  - `total` integer, required
  - `video` boolean, required

## Other responses

- `422`: Unprocessable Entity

---

[API](https://skmtc.dev/avatarfactory/apis/avatarfactory-api.md) · [All operations](https://skmtc.dev/avatarfactory/apis/avatarfactory-api/llms.txt) · [OpenAPI document](https://skmtc.dev/avatarfactory/apis/avatarfactory-api/revisions/66fc7aa3f296?raw)