---
title: "Request Document Access"
method: POST
path: "/v1/documents/{id}/requestAccess"
tags: ["Documents Collaboration"]
---

# Request Document Access

`POST /v1/documents/{id}/requestAccess`

## Request

- Base URL: `https://api.lucid.co`
- URL: `https://api.lucid.co/v1/documents/{id}/requestAccess`
- Auth: one of:
  - HTTP bearer
  - OAuth 2
    - Authorization code: `https://lucid.app/oauth2/authorize`
    - Token URL: `https://api.lucid.co/oauth2/token` scopes: `lucid.document.accessRequest`, `lucidchart.document.accessRequest`, `lucidspark.document.accessRequest`, `lucidscale.document.accessRequest`
- TypeScript: <https://skmtc.dev/lucid/apis/lucid-rest-api/docs/v1/documents/:id/requestAccess/post.ts> (a function with typed inputs; its response is checked against the schema)

Sends a request on behalf of the authenticated user asking the document's owner to grant them the provided role on the document.

## Path parameters

- `id` string, uuid, required

## Request body

- object
  - `role` 'editandshare' | 'edit' | 'comment' | 'view', required: Roles determine what actions an invitation will grant on a document. Invitations to a document only grant the specified level of access to just that one document. If a link's role is changed, the new role applies immediately to all users who accessed via that link. - `editandshare`: View, comment on, edit, and control which users can access the document. - `edit`: View, comment on, and edit the document. - `comment`: View the document. Leave comments on the document. - `view`: View the document.
  - `message` string, required: Message to include with the access request sent to the document's owner.

## Response `204`

No Content. The access request was successfully sent.

## Other responses

- `403`: Forbidden if the app making the request does not have permission to request access to the document, or if the document has been deleted, or does not exist.
- `429`: Too Many Requests if the user has sent too many access requests for the document. The `Retry-After` header indicates how long to wait before retrying.

## Changes

- **2026-11-03** `9c2c917ec59c`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/lucid/apis/lucid-rest-api/changes/v1/documents/:id/requestAccess/post.md)

---

[API](https://skmtc.dev/lucid/apis/lucid-rest-api.md) - [All operations](https://skmtc.dev/lucid/apis/lucid-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/lucid/apis/lucid-rest-api/revisions/9c2c917ec59c?raw)