Documents Collaboration

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.

get/v1/documents/{id}/shares/users/{userId}

Request

  • Base URL: https://api.lucid.co
  • URL: https://api.lucid.co/v1/documents/{id}/shares/users/{userId}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://lucid.app/oauth2/authorize, token URL https://api.lucid.co/oauth2/token, scopes: lucidchart.document.content.share.collaborator:readonly, lucidchart.document.app.picker.share.collaborator:readonly, lucidchart.document.app.folder, lucidscale.document.content.share.collaborator:readonly, lucidscale.document.app.picker.share.collaborator:readonly, lucidscale.document.app.folder, lucidspark.document.content.share.collaborator:readonly, lucidspark.document.app.picker.share.collaborator:readonly, lucidspark.document.app.folder)

Path parameters

idstring uuid required

ID of the document.

userIdnumber required

ID of the user to retrieve collaborator settings for.

Response

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

documentIdstring uuid required

Document ID

userIdinteger required

User ID

role'owner' | 'editandshare' | 'edit' | 'comment' | 'view' required

The Collaborator Role on the document or folder

createdstring date-time required

Date and time when the collaboration was created

Changes

No recorded changes to this operation across all 1 revision of this API.