---
title: "User onboarding"
method: PATCH
path: "/api/auth/onboarding/"
tags: ["auth"]
---

# User onboarding

`PATCH /api/auth/onboarding/`

## Request

- Base URL: `https://api.overmindlab.ai`
- URL: `https://api.overmindlab.ai/api/auth/onboarding/`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-Api-Key`
  - API key in cookie `sessionid`
  - API key in header `X-Api-Key`
  - HTTP bearer

Retrieve or update the authenticated user's onboarding record.

## Request body

- PatchedUserOnboardingRequest
  - `step` string
  - `status` string
  - `priorities` unknown
  - `description` string

## Response `200`

- UserOnboarding
  - `id` string, uuid, required
  - `step` string
  - `status` string
  - `priorities` unknown
  - `description` string
  - `created_at` string, date-time, required
  - `user` integer, required

---

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