---
title: "Setup checklist status"
method: GET
path: "/v1/home/onboarding"
tags: ["Home"]
---

# Setup checklist status

`GET /v1/home/onboarding`

Returns the signed-in user's onboarding checklist for a workspace, or `{ "track": null }` when no checklist applies (external sharees, established workspaces, or members who joined more than 14 days ago). Task labels are client-side; the server returns keys, done flags, and action hints.

## Query parameters

- `workspace` string

## Response `200`

Checklist status

- object
  - `track` 'admin' | 'member' | 'null', nullable
  - `tasks` object[]
    - `key` string
    - `done` boolean
    - `skippable` boolean
  - `pct` integer
  - `eligible` boolean
  - `dismissed` boolean
  - `celebrated` boolean

---

[API](https://skmtc.net/shareout/apis/shareout-rest-api.md) · [All operations](https://skmtc.net/shareout/apis/shareout-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shareout/shareout-rest-api/versions/804359ead65a/schema)