Manage Applications

    Find item for shared link

    get
    https://api.box.com/2.0
    /shared_items

    Return the file or folder represented by a shared link.

    Shared items are any files or folders that are represented by a shared link, which can originate within the current enterprise or within another one.

    This endpoint allows an application to retrieve information about a shared item when only given a shared link.

    Request

    application/json

    Request Headers

    stringin headerrequired
    shared_link=https://cloud.box.com/shared/static/gjasdasjhasd&shared_link_password=letmein

    A header containing the shared link and optional password for the shared link.

    The format for this header is as follows.

    shared_link=[link]&shared_link_password=[password]

    stringin headeroptional
    1

    Ensures an item is only returned if it has changed.

    Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.

    Response

    application/jsonItem

    Returns a full file or folder object if the shared link is valid and the user has access to it.

    none

    Returns an empty response when the If-None-Match header matches the current etag value of the folder. This indicates that the folder has not changed since it was last requested.

    You can now try out some of our APIs live, right here in the documentation.
    Log In

    Request Example

    cURL
    curl -X GET https://api.box.com/2.0/shared_items \
         -H "Authorization: Bearer <ACCESS_TOKEN>" \
         -H "BoxApi: shared_link=https://cloud.box.com/shared/static/gjasdasjhasd&shared_link_password=letmein"
    Java
    String sharedLink = "https://app.box.com/s/abcdefghijklmnopqrstuvwxyz123456";
    String password = "foo";
    BoxItem.Info itemInfo = BoxItem.getSharedItem(api, sharedLink, password);
    Node
    client.sharedItems.get(
        'https://app.box.com/s/1a2b3c4d5e',
        null,
        {fields: 'type,id,parent,extension,shared_link'},
        callback
    );

    Response Example

    {
      "id": 11446498,
      "type": "file",
      "sequence_id": 3,
      "etag": 1,
      "name": "Pictures"
    }