---
title: "Add User To Workspace"
method: POST
path: "/api/add_user_to_workspace"
tags: ["Admin"]
---

# Add User To Workspace

`POST /api/add_user_to_workspace`

## Request

- Base URL: `https://app.getdot.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://app.getdot.ai/api/add_user_to_workspace`
- Auth: one of:
  - API key in header `X-API-KEY`
  - API key in cookie `Authorization`
  - OAuth 2 (password, token URL `/api/auth/token`)

Add a user from the parent organization to a workspace.
For the main workspace, this switches user access from workspaces_only to full.
For regular workspaces, this creates a compound user ID for the workspace.
Only organization admins or workspace admins can add users.

## Request body

- BodyAddUserToWorkspaceApiAddUserToWorkspacePost
  - `user_email` string, required: Email of the user to add to workspace
  - `workspace_name` string, required: Name of the workspace
  - `role` string: Role for the user in the workspace. If not specified, uses workspace's new_user_admin setting.

## Response `200`

Successful Response

- unknown

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/getdot/apis/dot-api-2.md) · [All operations](https://skmtc.dev/getdot/apis/dot-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/getdot/apis/dot-api-2/revisions/d26fe7163a7f?raw)