---
title: "Get onboarding checklist"
method: GET
path: "/api/user/onboarding"
tags: ["User"]
---

# Get onboarding checklist

`GET /api/user/onboarding`

## Request

- Base URL: `https://demo.hitkeep.com`
- URL: `https://demo.hitkeep.com/api/user/onboarding`
- Auth: API key in cookie `hk_token`

Returns an onboarding checklist computed from sites, tracking status, team membership, and scheduled report state.

## Response `200`

Onboarding state

- UserOnboarding
  - `complete` boolean
  - `dismissed` boolean
  - `steps` OnboardingStep[]
    - `complete` boolean
    - `current` integer
    - `key` 'create_site' | 'verify_tracking' | 'automatic_events' | 'invite_teammate' | 'schedule_report'
    - `site_domain` string
    - `site_id` string, uuid
    - `target` integer

---

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