Get the shared link template

GET /api/2.0/files/{fileId}/sharedlink/template

Request

Returns a new unsaved link object to the file with the ID specified in the request.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Path

fileIdstring

File ID

Body

isFolderboolean

Specifies if a link is to the shared folder or not

Examples

GET /api/2.0/files/%7BfileId%7D/sharedlink/template HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request GET \
  --url https://example.com/api/2.0/files/%7BfileId%7D/sharedlink/template \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Shared link template

SubjectIdstringformat: uuid

SubjectNamestring

Linkstring

SubjectGroupboolean

Ownerboolean

Shareenum of integerformat: int32

[0 - None, 1 - ReadWrite, 2 - Read, 3 - Restrict, 4 - Varies, 5 - Review, 6 - Comment, 7 - FillForms, 8 - CustomFilter]

Can be one of: None, ReadWrite, Read, Restrict, Varies, Review, Comment, FillForms, CustomFilter.

LockedRightsboolean

DisableRemoveboolean

LinkSettingsobject

AutoDeleteboolean

ExpirationDatestring

Expiredboolean

Passwordstring

EntryTypeenum of integerformat: int32

[1 - Folder, 2 - File]

Can be one of: Folder, File.

Inheritedboolean

401

Unauthorized