Get shared link for folder


Gets the information for a shared link on a folder.



Path Parameters

stringin pathrequired

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://* the folder_id is 123.

The root folder of a Box account is always represented by the ID 0.

Query Parameters

stringin queryrequired

Explicitly request the shared_link fields to be returned for this item.


application/jsonFolder (Full)

Returns the base representation of a folder with the additional shared link information.

application/jsonClient error

Returned when the access token provided in the Authorization header is not recognized or not provided.

application/jsonClient error

Returned if the folder is not found, or the user does not have access to the folder.

application/jsonClient error

Returned if the folder_id is not in a recognized format.

application/jsonClient error

An unexpected client error.

Get shared link for folder
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

curl -i -X GET "" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
BoxFolder folder = new BoxFolder(api, "id");
BoxFolder.Info info = folder.getInfo()
BoxSharedLink link = info.getSharedLink()
String url = link.getUrl()
folder_id = '11111'
shared_link = client.folder(folder_id).get().shared_link
url = shared_link['url']
client.folders.get('11111', { fields: 'shared_link' })
  .then(folder => {
    let url = folder.shared_link.url
client.folders.getSharedLink(forFolder: "11111") { (result: Result<SharedLink, BoxSDKError>) in
    guard case let .success(sharedLink) = result else {
        print("Error retrieving folder shared link")

    print("Folder shared link URL is \(sharedLink.url), with \(sharedLink.access) access")

Response Example

  "id": "12345",
  "type": "folder",
  "etag": "1",
  "shared_link": {
    "url": "",
    "download_url": "",
    "vanity_url": null,
    "vanity_name": null,
    "effective_access": "open",
    "effective_permission": "can_download",
    "is_password_enabled": false,
    "unshared_at": "2020-09-21T10:34:41-07:00",
    "download_count": 0,
    "preview_count": 0,
    "access": "open",
    "permissions": {
      "can_preview": true,
      "can_download": true,
      "can_edit": false