---
title: "POST /accounts/workspace/invite/"
method: POST
path: "/accounts/workspace/invite/"
tags: ["accounts"]
---

# POST /accounts/workspace/invite/

`POST /accounts/workspace/invite/`

## Request

- Base URL: `http://localhost:8000`
- URL: `http://localhost:8000/accounts/workspace/invite/`
- Auth: one of:
  - API key in header `X-Api-Key`
  - API key in header `X-Secret-Key`

Invite users to workspaces

## Request body

- WorkspaceInvite
  - `emails` string[], required
  - `role` 'workspace_member' | 'workspace_admin' | 'workspace_viewer' | 'Member' | 'Viewer' | 'Owner' | 'Admin'
  - `select_all` boolean
  - `workspace_ids` string[]

## Response `200`

OK

- WorkspaceInviteResponse
  - `status` boolean, required
  - `result` WorkspaceInviteResult, required
    - `results` WorkspaceInviteResultItem[], required
      - `email` string, email, required
      - `status` string, required
      - `workspaces` string[], required
      - `select_all` boolean, required
      - `total_workspaces` integer, required
    - `total_invited` integer, required
    - `select_all` boolean, required
    - `total_workspaces` integer, required
    - `errors` WorkspaceInviteErrorItem[]
      - `email` string, email
      - `error` string, required

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `404`: Not Found
- `500`: Internal Server Error
- `default`: Default error response

---

[API](https://skmtc.dev/futureagi/apis/future-agi-management-api.md) · [All operations](https://skmtc.dev/futureagi/apis/future-agi-management-api/llms.txt) · [OpenAPI document](https://skmtc.dev/futureagi/apis/future-agi-management-api/revisions/c8684118e142?raw)