Box Developer Documentation
Log in
Latest version

Get shared link for folder

get
https://api.box.com/2.0
/folders/:folder_id

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Gets the information for a shared link on a folder.

Request

bearer [ACCESS_TOKEN]
application/json

Path Parameters

stringin pathrequired
12345

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://*.app.box.com/folder/123 the folder_id is 123.

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

Query Parameters

stringin queryrequired
shared_link

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

Response

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
Get shared link for folder
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versioning strategy.


cURL
curl -i -X GET "https://api.box.com/2.0/folders/32423234?fields=shared_link" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.sharedLinksFolders.getSharedLinkForFolder(folder.id, {
  fields: 'shared_link',
} satisfies GetSharedLinkForFolderQueryParams);
Python v10
client.shared_links_folders.get_shared_link_for_folder(folder.id, "shared_link")
.NET v10
await client.SharedLinksFolders.GetSharedLinkForFolderAsync(folderId: folder.Id, queryParams: new GetSharedLinkForFolderQueryParams(fields: "shared_link"));
Swift v10
try await client.sharedLinksFolders.getSharedLinkForFolder(folderId: folder.id, queryParams: GetSharedLinkForFolderQueryParams(fields: "shared_link"))
Java v10
client.getSharedLinksFolders().getSharedLinkForFolder(folder.getId(), new GetSharedLinkForFolderQueryParams("shared_link"))
Java v5
BoxFolder folder = new BoxFolder(api, "id");
BoxFolder.Info info = folder.getInfo()
BoxSharedLink link = info.getSharedLink()
String url = link.getUrl()
Python v4
folder_id = '11111'
shared_link = client.folder(folder_id).get().shared_link
url = shared_link['url']
Node v4
client.folders.get('11111', { fields: 'shared_link' })
  .then(folder => {
    let url = folder.shared_link.url
    //...
  })

Response Example

{
  "etag": "1",
  "id": "12345",
  "shared_link": {
    "access": "open",
    "download_count": 0,
    "download_url": "https://app.box.com/shared/static/kwio6b4ovt1264rnfbyqo1.pdf",
    "effective_access": "open",
    "effective_permission": "can_download",
    "is_password_enabled": false,
    "permissions": {
      "can_download": true,
      "can_edit": false,
      "can_preview": true
    },
    "preview_count": 0,
    "unshared_at": "2020-09-21T10:34:41-07:00",
    "url": "https://app.box.com/s/kwio6b4ovt1264rnfbyqo1",
    "vanity_name": null,
    "vanity_url": null
  },
  "type": "folder"
}