---
title: "See setup progress"
method: GET
path: "/api/v1/onboarding"
tags: ["authed"]
---

# See setup progress

`GET /api/v1/onboarding`

## Request

- Base URL: `https://api.teaflask.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.teaflask.com/api/v1/onboarding`
- Auth: none declared

Which parts of the organization's setup are done: a connected
repository, a scan for API actions, docs, and the assistant installed on
its site. Each step says whether it is complete and whether another step
must come first.

## Response `200`

Successful Response

- OnboardingResponse
  - `steps` OnboardingStepView[], required: Every setup step, in the order a workspace fills them in.
    - `step_key` 'connect_repository' | 'actions_scan' | 'bring_docs' | 'install', required
    - `eligible` boolean, required: Whether the step can be started now; false while another step must come first.
    - `locked_by` 'connect_repository' | 'actions_scan' | 'bring_docs' | 'install', required
    - `complete` boolean, required: Whether the step is done. actions_scan counts once any scan — of a repository or of uploaded spec files — has been started and stays done even if the repository is later disconnected; the other steps follow the current state, so disconnecting the repository, deleting every doc or revoking the last active key turns them back to incomplete.

## Other responses

- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not found
- `405`: Method not allowed
- `422`: Validation error
- `500`: Internal server error

---

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