---
title: "Create the user row and optional first workspace on first sign-in"
method: POST
path: "/api/users/onboard"
tags: ["users"]
---

# Create the user row and optional first workspace on first sign-in

`POST /api/users/onboard`

## Request

- Base URL: `https://api.hillstar.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.hillstar.ai/api/users/onboard`
- Auth: none declared

## Request body

- OnboardingRequest
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `first_name` string, required
  - `job_title` string, required
  - `last_name` string, required
  - `phone` string
  - `profile_image_url` string
  - `workspace_name` string

## Response `200`

OK

- OnboardingResponse
  - `$schema` string, uri: A URL to the JSON Schema for this object.
  - `user` UserResponse, required
    - `$schema` string, uri: A URL to the JSON Schema for this object.
    - `avatar` AvatarResponse
      - `bird_id` string, nullable
      - `initials` string, nullable
      - `photo_url` string, nullable
      - `type` 'photo' | 'bird' | 'initials', required: Avatar display type.
    - `created_at` string, date-time, required
    - `email` string, required
    - `first_name` string, required
    - `id` integer, required
    - `job_title` string, required
    - `last_name` string, required
    - `onboarding_complete` boolean, required
    - `phone` string, nullable, required
    - `preferences` object, nullable
    - `profile_complete` boolean, required
    - `updated_at` string, date-time, required
  - `workspace_id` integer
  - `workspace_name` string

## Other responses

- `default`: Error

---

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