LUlucid
Documents Sharing

Get Document Share Link

Changed on

Retrieves information about a share link on the specified document. This endpoint will only retrieve information about share links created by the same OAuth2.0 client.

get/v1/documents/{id}/shares/shareLinks/{shareLinkId}

Request

  • Base URL
    https://api.lucid.co
  • Auth
    OAuth 2
    Authorization codehttps://lucid.app/oauth2/authorize
    Token URLhttps://api.lucid.co/oauth2/token
    Scopeslucidchart.document.content.share.link:readonly, lucidchart.document.app.picker.share.link:readonly, lucidchart.document.app.folder, lucidscale.document.content.share.link:readonly, lucidscale.document.app.picker.share.link:readonly, lucidscale.document.app.folder, lucidspark.document.content.share.link:readonly, lucidspark.document.app.picker.share.link:readonly, lucidspark.document.app.folder
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring uuid required

ID of the document.

shareLinkIdstring required

Id of the share link to retrieve information for.

Response

OK with a Document Share Link resource containing information about the requested share link.

shareLinkIdstring required

Id of the share link.

documentIdstring uuid required

Id of the document the share link belongs to.

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.
createdstring date-time required

The date and time the share link was created.

createdBynumber required

User Id of the user that created the share link.

lastModifiedstring date-time required

The date and time the share link was last modified.

acceptUrlstring uri required

Link to accept the share link invitation.

Example response

{
  "shareLinkId": "inv_8a38797a-e5fc-4479-8492-e000dc93cb60",
  "documentId": "f6bf19b5-d109-4ef5-92b2-cdaf0de43001",
  "linkSecurity": {
    "restrictToAccount": false,
    "expires": "2023-12-11T21:48:35.293Z",
    "passcode": "password",
    "allowAnonymous": false
  },
  "created": "2022-11-11T21:48:35.293Z",
  "createdBy": 1280,
  "lastModified": "2022-11-11T21:48:35.293Z",
  "acceptUrl": "https://lucid.app/lucidchart/f6bf19b5-d109-4ef5-92b2-cdaf0de43001/edit?invitationId=inv_8a38797a-e5fc-4479-8492-e000dc93cb60"
}

Changes