---
title: "GET /v1/workspaces/{workspaceId}/onboarding"
method: GET
path: "/v1/workspaces/{workspaceId}/onboarding"
tags: ["Workspaces"]
---

# GET /v1/workspaces/{workspaceId}/onboarding

`GET /v1/workspaces/{workspaceId}/onboarding`

Returns the onboarding checklist state for a workspace.

## Path parameters

- `workspaceId` string, uuid, required

## Headers

- `Authorization` string

## Response `200`

Default Response

- object
  - `data` object, required
    - `steps` object[], required
      - `id` union, required
        - 'setup-github'
        - 'generate-tile'
      - `completed` boolean, required
      - `optional` boolean, required

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found
- `500` — Internal Server Error

## Changes

- **2026-08-28** `d1ef4ac0815d` — 1 info
  - removed `subschema #2` from the `data/steps/items/id` response property `anyOf` list for the response status `200`

[Change history](https://skmtc.dev/tessl/apis/tessl-api/changes/v1/workspaces/:workspaceId/onboarding/get.md)

---

[API](https://skmtc.dev/tessl/apis/tessl-api.md) · [All operations](https://skmtc.dev/tessl/apis/tessl-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/tessl/tessl-api/revisions/593ffe7cdc7b/schema)