Get Document User Collaborator

Retrieves information about a specific user's collaboration access level for a given document, including the sharing permissions and role that the user has been granted.

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


Valid Authentication Methods

API Key Grants:

  • DocumentReadonly

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

Path Params
uuid
required

ID of the document.

number
required

ID of the user to retrieve collaborator settings for.

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
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json