{ "opencollection": "1.0.0", "info": { "name": "Box Authorize Authorization Shared Links (Folders) API", "version": "1.0" }, "items": [ { "info": { "name": "Shared Links (Folders)", "type": "folder" }, "items": [ { "info": { "name": "Box Find folder for shared link", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/shared_items#folders", "headers": [ { "name": "if-none-match", "value": "1" }, { "name": "boxapi", "value": "shared_link=[link]&shared_link_password=[password]" } ], "params": [ { "name": "fields", "value": "id,type,name", "type": "query", "description": "A comma-separated list of attributes to include in the\nresponse. This can be used to request fields that are\nnot normally returned in a standard response.\n\nBe aware that specifying this parameter will have the\neffect that none of the standard fields are returned in\nthe response unless explicitly specified, instead only\nfields for the mini representation are returned, additional\nto the fields requested." } ] }, "docs": "Return the folder represented by a shared link.\n\nA shared folder can be represented by a shared link,\nwhich can originate within the current enterprise or within another.\n\nThis endpoint allows an application to retrieve information about a\nshared folder when only given a shared link." }, { "info": { "name": "Box Get shared link for folder", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/folders/:folder_id#get_shared_link", "params": [ { "name": "folder_id", "value": "12345", "type": "path", "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ] }, "docs": "Gets the information for a shared link on a folder." }, { "info": { "name": "Box Add shared link to folder", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/folders/:folder_id#add_shared_link", "params": [ { "name": "folder_id", "value": "12345", "type": "path", "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a shared link to a folder." }, { "info": { "name": "Box Update shared link on folder", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/folders/:folder_id#update_shared_link", "params": [ { "name": "folder_id", "value": "12345", "type": "path", "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates a shared link on a folder." }, { "info": { "name": "Box Remove shared link from folder", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/folders/:folder_id#remove_shared_link", "params": [ { "name": "folder_id", "value": "12345", "type": "path", "description": "The unique identifier that represent a folder.\n\nThe ID for any folder can be determined\nby visiting this folder in the web application\nand copying the ID from the URL. For example,\nfor the URL `https://*.app.box.com/folder/123`\nthe `folder_id` is `123`.\n\nThe root folder of a Box account is\nalways represented by the ID `0`." }, { "name": "fields", "value": "shared_link", "type": "query", "description": "Explicitly request the `shared_link` fields\nto be returned for this item." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Removes a shared link from a folder." } ] } ], "bundled": true }