Get Document User Collaborator

get https://api.lucid.co/documents/{id}/shares/users/{userId}

Gets information about the user's collaboration access to the provided document.

Valid Authentication Methods

API Key Grants:

DocumentRead

OAuth 2.0 User Token Scopes:

lucidchart.document.content.share.collaborator
lucidchart.document.app.picker.share.collaborator
lucidchart.document.app.folder
lucidscale.document.content.share.collaborator
lucidscale.document.app.picker.share.collaborator
lucidscale.document.app.folder
lucidspark.document.content.share.collaborator
lucidspark.document.app.picker.share.collaborator
lucidspark.document.app.folder

Responses

403

Forbidden if the app making the request does not have permission to the document, or if the document has been deleted, or does not exist.

404

Not Found when a user with the specified ID can not be found or does not have collaborator access to the document.

Language

Credentials


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.lucid.co/documents/id/shares/users/userId \
3
     --header 'Lucid-Api-Version: 1' \
4
     --header 'accept: application/json'


xxxxxxxxxx
 
1
{
2
  "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
3
  "userId": 0,
4
  "role": "owner",
5
  "created": "2025-04-03T17:51:56.950Z"
6
}

Valid Authentication Methods

API Key Grants:

OAuth 2.0 User Token Scopes:

200OK with a Document User Collaborator Resource containing information about the user's collaboration settings.