---
title: "Share Workspace By Email"
method: POST
path: "/api/workspaces/{workspace_id}/access"
tags: ["workspaces"]
---

# Share Workspace By Email

`POST /api/workspaces/{workspace_id}/access`

## Path parameters

- `workspace_id` string, required

## Query parameters

- `frontend_origin` string, nullable

## Request body

- ShareByEmailRequest
  - `emails` string[], required
  - `role` string, required
  - `message` string, required

## Response `200`

Successful Response

- WorkspaceAccessResponse
  - `grants` AccessGrantResponse[], required
    - `grant_id` string, required
    - `user_id` string, nullable, required
    - `name` string, nullable, required
    - `email` string, nullable, required
    - `role` string, required
    - `origin` string, required
    - `created_at` string, required
  - `share_link` ShareLinkResponse, required
    - `mode` 'restricted' | 'org' | 'public', required
    - `secret` string, nullable, required
    - `published` boolean
    - `enabled` boolean, required
  - `available_link_modes` ShareLinkMode[], required
  - `can_publish_link` boolean, required

## Other responses

- `422` — Validation Error

## Changes

- **2026-09-23** `d7f2f3b8e82d` — 2 info
  - added the optional property `share_link/published` to the response with the `200` status
  - added the required property `can_publish_link` to the response with the `200` status
- **2026-09-18** `abf76937a751` — 2 info
  - added the optional property `detail/items/ctx` to the response with the `422` status
  - added the optional property `detail/items/input` to the response with the `422` status
- **2026-09-11** `b6d2db8786ed` — 3 breaking, 1 warning, 6 info
  - added the new required request property `emails`
  - added the new required request property `message`
  - response property `grants/items/user_id` list-of-types was widened by adding types `null` to media type `application/json` of response `200`
  - removed the request property `email`
  - …6 more
- **2026-09-10** `3a8d4a28ae93` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/quadrillion/apis/quadrillion-cloud-api/changes/api/workspaces/:workspace_id/access/post.md)

---

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