Get Document Share Link

get https://api.lucid.co/documents/{id}/shares/shareLinks/{shareLinkId}

Gets information about the share link on the provided document.

📘
This endpoint will only retrieve information about share links created by the same OAuth2.0 client

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

lucidchart.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

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 if the share link id with the specified document id does not belong to the document, does not exist, or the requesting app did not create the share link.

Language

Credentials

OAuth2


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


xxxxxxxxxx
15
 
1
{
2
  "shareLinkId": "inv_8a38797a-e5fc-4479-8492-e000dc93cb60",
3
  "documentId": "f6bf19b5-d109-4ef5-92b2-cdaf0de43001",
4
  "role": "editandshare",
5
  "linkSecurity": {
6
    "restrictToAccount": false,
7
    "expires": "2023-12-11T21:48:35.293Z",
8
    "passcode": "password",
9
    "allowAnonymous": false
10
  },
11
  "created": "2022-11-11T21:48:35.293Z",
12
  "createdBy": 1280,
13
  "lastModified": "2022-11-11T21:48:35.293Z",
14
  "acceptUrl": "https://lucid.app/lucidchart/f6bf19b5-d109-4ef5-92b2-cdaf0de43001/edit?invitationId=inv_8a38797a-e5fc-4479-8492-e000dc93cb60"
15
}

📘

Valid Authentication Methods

OAuth 2.0 User Token Scopes:

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