{ "info": { "_postman_id": "9dd1010c-7c69-4092-af6c-e4310168af5d", "name": "Box Authorize Authorization Folders API", "description": "Needs a description.", "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "lastUpdatedBy": "35240", "uid": "35240-9dd1010c-7c69-4092-af6c-e4310168af5d" }, "item": [ { "name": "folders", "item": [ { "name": "{folder_id}", "item": [ { "name": "items", "item": [ { "name": "Box List items in folder", "id": "ae1386d6-2c51-467a-b7c8-4d7e6d51ba6f", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/items?fields=,&usemarker=&marker=&offset=0&limit=&sort=id&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "items" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" } ], "variable": [ { "id": "219d7d0b-67a4-4d84-a04f-37f9480f9c09", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieves a page of items in a folder. These items can be files,\nfolders, and web links.\n\nTo request more information about the folder itself, like its size,\nuse the [Get a folder](#get-folders-id) endpoint instead." }, "response": [ { "id": "67b1bae7-29cf-4572-8201-e46b5d05aa86", "name": "Returns a collection of files, folders, and web links contained in a folder.", "originalRequest": { "method": "GET", "header": [ { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/items?fields=,&usemarker=&marker=&offset=0&limit=&sort=id&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "items" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n },\n {\n \"by\": \"\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopiplus\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"base_explorer\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"base_preview\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"co-owner\",\n \"previewer uploader\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"aliqua_1\": {\n \"eu_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut_4\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1cc\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"inf\": {\n \"pariatur09\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"pending\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_preview\"\n ]\n },\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_download\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"trashed\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopiplus\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_view_self\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"item_preview\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"viewer uploader\",\n \"previewer\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"in_fb_\": {\n \"aliqua7d\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"consequat_a2\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\",\n \"can_download\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-67b1bae7-29cf-4572-8201-e46b5d05aa86" }, { "id": "47a63696-f7cb-4256-8849-7bad69204833", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/items?fields=,&usemarker=&marker=&offset=0&limit=&sort=id&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "items" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-47a63696-f7cb-4256-8849-7bad69204833" }, { "id": "1c9449ad-7211-427e-8147-91133dfcdc0b", "name": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "originalRequest": { "method": "GET", "header": [ { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/items?fields=,&usemarker=&marker=&offset=0&limit=&sort=id&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "items" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1c9449ad-7211-427e-8147-91133dfcdc0b" }, { "id": "f16474be-bce5-4e70-875c-8631fe24b015", "name": "Returned if the `folder_id` is not in a recognized format.", "originalRequest": { "method": "GET", "header": [ { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/items?fields=,&usemarker=&marker=&offset=0&limit=&sort=id&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "items" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f16474be-bce5-4e70-875c-8631fe24b015" }, { "id": "25428f05-b0cb-4f3d-8892-3bea601c3649", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/items?fields=,&usemarker=&marker=&offset=0&limit=&sort=id&direction=ASC", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "items" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-25428f05-b0cb-4f3d-8892-3bea601c3649" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-ae1386d6-2c51-467a-b7c8-4d7e6d51ba6f" } ], "id": "c8690869-2d93-4e14-8fa2-117f319fae37", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c8690869-2d93-4e14-8fa2-117f319fae37" }, { "name": "copy", "item": [ { "name": "Box Copy folder", "id": "3dc6e239-9899-4afb-9b70-f068955f6ae6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "id": "03b2be60-24e7-49a2-aa0f-ad53250d6b4c", "key": "folder_id", "value": "", "description": "(Required) The unique identifier of the folder to copy.\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 with the ID `0` can not be copied." } ] }, "description": "Creates a copy of a folder within a destination folder.\n\nThe original folder will not be changed." }, "response": [ { "id": "d1f1471c-8759-4406-aa3b-cf351b76b984", "name": "Returns a new folder object representing the copied folder.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d1f1471c-8759-4406-aa3b-cf351b76b984" }, { "id": "701e8eb5-3f43-4851-92dc-ef3b5927ff56", "name": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Modified", "code": 304, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-701e8eb5-3f43-4851-92dc-ef3b5927ff56" }, { "id": "50a15f70-fc76-462e-bd30-3c89691c25ce", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `bad_request` when a parameter is missing.\n* `item_name_too_long` when the new folder name is too long.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-50a15f70-fc76-462e-bd30-3c89691c25ce" }, { "id": "196f80d3-8e7e-4c7f-a823-f5c7d5155477", "name": "Returns an error when the user does not have the\nright permissions to copy a folder.\n\n* `forbidden_by_policy`: Returned if copying a folder is\nforbidden due to information barrier restrictions.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-196f80d3-8e7e-4c7f-a823-f5c7d5155477" }, { "id": "1bb2d1bb-26ea-463d-ac00-838b34805281", "name": "Returns an error if either the source or destination folder\ncould not be found, or the authenticated user does not\nhave access to either folders.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1bb2d1bb-26ea-463d-ac00-838b34805281" }, { "id": "1696618a-caf8-4a0e-994b-35127690b43f", "name": "Returns an error if a folder by this name already exists\nin the destination folder, or if the destination folder\nis locked.\n\n* `item_name_in_use` when a folder with the same name already\n exists.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1696618a-caf8-4a0e-994b-35127690b43f" }, { "id": "6b43898a-0b17-4025-ad4b-e94ae685162f", "name": "Returns an error when trying to copy the root folder.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-6b43898a-0b17-4025-ad4b-e94ae685162f" }, { "id": "fc72957f-f96e-40fd-8105-f1e3801d2296", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"parent\": {\n \"id\": \"\"\n },\n \"name\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/copy?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "copy" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-fc72957f-f96e-40fd-8105-f1e3801d2296" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-3dc6e239-9899-4afb-9b70-f068955f6ae6" } ], "id": "5e8eeea2-fb83-4e64-99d3-16988d568348", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-5e8eeea2-fb83-4e64-99d3-16988d568348" }, { "name": "collaborations", "item": [ { "name": "Box List folder collaborations", "id": "8b228a6b-4c04-4922-a7d1-d6dd3d1106be", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/collaborations?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "collaborations" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "id": "7bd9ecc2-68a9-4ad1-b774-7fe9b68c6fe5", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieves a list of pending and active collaborations for a\nfolder. This returns all the users that have access to the folder\nor have been invited to the folder." }, "response": [ { "id": "b1af24ac-70f3-4e68-9e19-84c33a3372fd", "name": "Returns a collection of collaboration objects. If there are no\ncollaborations on this folder an empty collection will be returned.\n\nThis list includes pending collaborations, for which the `status`\nis set to `pending`, indicating invitations that have bee", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/collaborations?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "collaborations" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "null", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b1af24ac-70f3-4e68-9e19-84c33a3372fd" }, { "id": "c0e45295-486b-4311-a4aa-34683d2af970", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/collaborations?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "collaborations" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c0e45295-486b-4311-a4aa-34683d2af970" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-8b228a6b-4c04-4922-a7d1-d6dd3d1106be" } ], "id": "b8b31eb8-39f6-43d9-a30d-a3d29bfb3da8", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b8b31eb8-39f6-43d9-a30d-a3d29bfb3da8" }, { "name": "trash", "item": [ { "name": "Box Get trashed folder", "id": "36a901fa-4dd2-430a-a4fd-6122f88348f5", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "id": "a53dba96-843b-4e83-b71d-d2c74b992513", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieves a folder that has been moved to the trash.\n\nPlease note that only if the folder itself has been moved to the\ntrash can it be retrieved with this API call. If instead one of\nits parent folders was moved to the trash, only that folder\ncan be inspected using the\n[`GET /folders/:id/trash`](e://get_folders_id_trash) API.\n\nTo list all items that have been moved to the trash, please\nuse the [`GET /folders/trash/items`](e://get-folders-trash-items/)\nAPI." }, "response": [ { "id": "1a0c7cc3-fc41-429b-870c-0370d357a27a", "name": "Returns the folder that was trashed,\nincluding information about when the it\nwas moved to the trash.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"name\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"type\": \"folder\",\n \"id\": \"\",\n \"sequence_id\": \"\",\n \"etag\": \"\",\n \"name\": \"\"\n },\n {\n \"type\": \"folder\",\n \"id\": \"\",\n \"sequence_id\": \"\",\n \"etag\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"item_status\": \"deleted\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"shared_link\": \"\",\n \"folder_upload_email\": \"\",\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1a0c7cc3-fc41-429b-870c-0370d357a27a" }, { "id": "e1a74444-18e7-4da4-abfb-ab79a0c03ae7", "name": "Returns an error if the folder can not be found directly\nin the trash.\n\nPlease note that a `HTTP 404` is also returned if any of\nthe folder's parent folders have been moved to the trash.\n\nIn that case, only that parent folder can be inspected using\nthe [`", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e1a74444-18e7-4da4-abfb-ab79a0c03ae7" }, { "id": "0ff9b8e2-b2f5-4343-bc68-4281170a2e09", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-0ff9b8e2-b2f5-4343-bc68-4281170a2e09" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-36a901fa-4dd2-430a-a4fd-6122f88348f5" }, { "name": "Box Permanently remove folder", "id": "b2f7f963-c0be-4e5d-840e-a792c4b9db77", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "variable": [ { "id": "da5b9a6c-beed-43b2-8d9d-6f42e72a87ae", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Permanently deletes a folder that is in the trash.\nThis action cannot be undone." }, "response": [ { "id": "dd378eeb-833a-433c-b5c2-631164a4d680", "name": "Returns an empty response when the folder was\npermanently deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "variable": [ { "key": "folder_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-dd378eeb-833a-433c-b5c2-631164a4d680" }, { "id": "f508df43-541e-4524-bad1-f4ce2fbbbae1", "name": "Returns an error if the folder is not in the trash.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f508df43-541e-4524-bad1-f4ce2fbbbae1" }, { "id": "09ddeb4b-27f1-4aa5-9cf2-ec0209324035", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/trash", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "trash" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-09ddeb4b-27f1-4aa5-9cf2-ec0209324035" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b2f7f963-c0be-4e5d-840e-a792c4b9db77" } ], "id": "e89dfa67-c037-49fd-9d25-ae4b8cb697e7", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e89dfa67-c037-49fd-9d25-ae4b8cb697e7" }, { "name": "metadata", "item": [ { "name": "enterprise", "item": [ { "name": "securityClassification-6VMVochwUWo", "item": [ { "name": "Box Get classification on folder", "id": "e0864253-1739-4a9a-9a2e-e09b82dcd9e0", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "67c47447-d6e3-4b91-ac26-bd507105a4ac", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieves the classification metadata instance that\nhas been applied to a folder.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, "response": [ { "id": "d129be1b-4beb-4383-af2a-1679f91dccae", "name": "Returns an instance of the `securityClassification` metadata\ntemplate, which contains a `Box__Security__Classification__Key`\nfield that lists all the classifications available to this\nenterprise.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Box__Security__Classification__Key\": \"\",\n \"$parent\": \"\",\n \"$template\": \"securityClassification-6VMVochwUWo\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$canEdit\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d129be1b-4beb-4383-af2a-1679f91dccae" }, { "id": "be8096b2-d0bf-432e-ab45-7ec5166ed3c0", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-be8096b2-d0bf-432e-ab45-7ec5166ed3c0" }, { "id": "dbd7f843-59a6-4f5f-9321-3394af7aa7d2", "name": "Returned if the metadata template specified\nwas not applied to this folder or the user does not have access to the\nfolder.\n\n* `instance_not_found` - The metadata template was not applied to the\nfolder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-dbd7f843-59a6-4f5f-9321-3394af7aa7d2" }, { "id": "f5780614-0e4f-4377-aa1c-11fe7441d5dc", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f5780614-0e4f-4377-aa1c-11fe7441d5dc" }, { "id": "911194c2-2407-4d8f-89b8-7fc82252da97", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-911194c2-2407-4d8f-89b8-7fc82252da97" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e0864253-1739-4a9a-9a2e-e09b82dcd9e0" }, { "name": "Box Add classification to folder", "id": "78d5202e-e768-4309-ac06-80ec7a5191fe", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "9320f4c4-abe3-4f57-9c82-fcf6f2f74b6c", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Adds a classification to a folder by specifying the label of the\nclassification to add.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, "response": [ { "id": "064c517b-1c3d-45df-bd25-4f24a010d2fe", "name": "Returns the classification template instance\nthat was applied to the folder.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Box__Security__Classification__Key\": \"\",\n \"$parent\": \"\",\n \"$template\": \"securityClassification-6VMVochwUWo\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$canEdit\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-064c517b-1c3d-45df-bd25-4f24a010d2fe" }, { "id": "47d48e6f-a484-4a0d-9a8c-cedfb8d2bb86", "name": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for a for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-47d48e6f-a484-4a0d-9a8c-cedfb8d2bb86" }, { "id": "6ff0c470-7b4d-46cd-a37c-a9ce29778df8", "name": "Returns an error when the folder or metadata template was not found.\n\n* `not_found` - The folder could not be found, or the user does not have\naccess to the folder.\n* `instance_tuple_not_found` - The metadata template was not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-6ff0c470-7b4d-46cd-a37c-a9ce29778df8" }, { "id": "58422578-91a8-4f1f-821b-aba35d4553c2", "name": "Returns an error when an instance of this metadata template is already\npresent on the folder.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the folder.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-58422578-91a8-4f1f-821b-aba35d4553c2" }, { "id": "4378d025-eacb-4ec8-8ea8-d675e7ea913d", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"Box__Security__Classification__Key\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-4378d025-eacb-4ec8-8ea8-d675e7ea913d" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-78d5202e-e768-4309-ac06-80ec7a5191fe" }, { "name": "Box Update classification on folder", "id": "eaed501b-4805-4d55-a454-67eb89002a82", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "7cacceec-8cd3-4eba-a43e-f29e664900c3", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Updates a classification on a folder.\n\nThe classification can only be updated if a classification has already been\napplied to the folder before. When editing classifications, only values are\ndefined for the enterprise will be accepted." }, "response": [ { "id": "7011686b-ad31-4312-b72b-820d8e5e7e34", "name": "Returns the updated classification metadata template instance.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"Box__Security__Classification__Key\": \"\",\n \"$parent\": \"\",\n \"$template\": \"securityClassification-6VMVochwUWo\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\",\n \"$canEdit\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-7011686b-ad31-4312-b72b-820d8e5e7e34" }, { "id": "527c2e84-9f93-4b1e-be6a-917acf6a7467", "name": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch operations.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-527c2e84-9f93-4b1e-be6a-917acf6a7467" }, { "id": "d6b30fc5-6669-442b-aaee-63d15ce16f3f", "name": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d6b30fc5-6669-442b-aaee-63d15ce16f3f" }, { "id": "e2fb4fe2-b641-46d5-8714-1d4a7f1236b2", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n },\n {\n \"op\": \"replace\",\n \"path\": \"/Box__Security__Classification__Key\",\n \"value\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e2fb4fe2-b641-46d5-8714-1d4a7f1236b2" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-eaed501b-4805-4d55-a454-67eb89002a82" }, { "name": "Box Remove classification from folder", "id": "7c482682-0b71-4d7c-bdf7-3fa95ba18b35", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "id": "836e30bf-5969-4fd1-bef5-b22f3d16abc5", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Removes any classifications from a folder.\n\nThis API can also be called by including the enterprise ID in the\nURL explicitly, for example\n`/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo`." }, "response": [ { "id": "96140f95-3d7d-43ec-bc31-3296b5c0455b", "name": "Returns an empty response when the classification is\nsuccessfully deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-96140f95-3d7d-43ec-bc31-3296b5c0455b" }, { "id": "e5a4ba6a-28b2-49e9-add3-85e92385c600", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e5a4ba6a-28b2-49e9-add3-85e92385c600" }, { "id": "f36509df-9aee-4ca7-90e4-690508363fff", "name": "Returns an error when the folder does not have any classification applied\nto it, or when the user does not have access to the\nfolder.\n\n* `instance_not_found` - An instance of the classification metadata\ntemplate with the was not found on this folder.\n* `n", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f36509df-9aee-4ca7-90e4-690508363fff" }, { "id": "c4d92679-cdc3-4c29-8bff-227e58a244b2", "name": "Returned when the method was not allowed.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c4d92679-cdc3-4c29-8bff-227e58a244b2" }, { "id": "5ae6a985-7398-422a-8237-bef10ace9a7c", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/enterprise/securityClassification-6VMVochwUWo", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", "enterprise", "securityClassification-6VMVochwUWo" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-5ae6a985-7398-422a-8237-bef10ace9a7c" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-7c482682-0b71-4d7c-bdf7-3fa95ba18b35" } ], "id": "f7fb121a-6b5f-4163-8deb-731855c37e59", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f7fb121a-6b5f-4163-8deb-731855c37e59" } ], "id": "2f5e170c-dbf4-442b-b96e-1ea7dc083b73", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-2f5e170c-dbf4-442b-b96e-1ea7dc083b73" }, { "name": "{scope}", "item": [ { "name": "{template_key}", "item": [ { "name": "Box Get metadata instance on folder", "id": "768f0822-aaf1-4ced-83cb-58d12e68f18e", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "e4672d11-9bfd-488a-92a7-b44b2a025011", "key": "folder_id", "value": "", "description": "(Required) 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`." }, { "id": "3b403c83-22b2-47fd-991a-2195e20e7fa0", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "4f6e9ca3-9878-452c-816b-036611f0acf0", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Retrieves the instance of a metadata template that has been applied to a\nfolder. This can not be used on the root folder with ID `0`." }, "response": [ { "id": "ef222773-054a-4c84-8caf-1f2713ce644c", "name": "An instance of the metadata template that includes\nadditional \"key:value\" pairs defined by the user or\nan application.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-ef222773-054a-4c84-8caf-1f2713ce644c" }, { "id": "877d8983-6330-493a-897d-6c4d39635a43", "name": "Returned when the request parameters are not valid.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-877d8983-6330-493a-897d-6c4d39635a43" }, { "id": "381e120e-0047-4f86-b4d1-950f675ccf76", "name": "Returned if the metadata template specified\nwas not applied to this folder or the user does not have access to the\nfolder.\n\n* `instance_not_found` - The metadata template was not applied to the\nfolder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-381e120e-0047-4f86-b4d1-950f675ccf76" }, { "id": "9d5b3da9-6a5b-4df7-819f-846f6b7813ab", "name": "Returned when the method was not allowed. This often happens when the\nfolder ID is not valid or the root folder with ID `0`.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9d5b3da9-6a5b-4df7-819f-846f6b7813ab" }, { "id": "84867fc6-a2d4-4f06-b8c1-54552c7e98be", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-84867fc6-a2d4-4f06-b8c1-54552c7e98be" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-768f0822-aaf1-4ced-83cb-58d12e68f18e" }, { "name": "Box Create metadata instance on folder", "id": "1b1a6a6c-a379-4a65-9844-671ef5c543fa", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minim6\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present on the metadata\\ntemplate.\\nFor the `global.properties` template this can be a list of zero\\nor more fields, as this template allows for any generic key-value\\npairs to be stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "b65b38fc-1718-4fd9-b1db-43a2315e2f18", "key": "folder_id", "value": "", "description": "(Required) 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`." }, { "id": "3a65bd04-c420-4cd4-86dd-c13fe6b16dd9", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "e88c300a-20c5-4d1e-8f02-9bf7c0944d39", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Applies an instance of a metadata template to a folder.\n\nIn most cases only values that are present in the metadata template\nwill be accepted, except for the `global.properties` template which accepts\nany key-value pair.\n\nTo display the metadata template in the Box web app the enterprise needs to be\nconfigured to enable **Cascading Folder Level Metadata** for the user in the\nadmin console." }, "response": [ { "id": "541ae4d9-0dd8-46cd-a2b1-855a3163da52", "name": "Returns the instance of the template that was applied to the folder,\nincluding the data that was applied to the template.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minim6\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present on the metadata\\ntemplate.\\nFor the `global.properties` template this can be a list of zero\\nor more fields, as this template allows for any generic key-value\\npairs to be stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-541ae4d9-0dd8-46cd-a2b1-855a3163da52" }, { "id": "53535b85-9ec2-49cf-aef1-e99d45f700a7", "name": "Returns an error when the request body is not valid.\n\n* `schema_validation_failed` - The request body contains a value for\na field that either does not exist, or for which the value or type does\nnot match the expected field type. An example might be an un", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minim6\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present on the metadata\\ntemplate.\\nFor the `global.properties` template this can be a list of zero\\nor more fields, as this template allows for any generic key-value\\npairs to be stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-53535b85-9ec2-49cf-aef1-e99d45f700a7" }, { "id": "b1f88435-828a-4b78-b7b1-e3e5dea0f72c", "name": "Returns an error when the folder or metadata template was not found.\n\n* `not_found` - The folder could not be found, or the user does not have\naccess to the folder.\n* `instance_tuple_not_found` - The metadata template was not found.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minim6\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present on the metadata\\ntemplate.\\nFor the `global.properties` template this can be a list of zero\\nor more fields, as this template allows for any generic key-value\\npairs to be stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b1f88435-828a-4b78-b7b1-e3e5dea0f72c" }, { "id": "33b19d19-49fe-444b-ab74-ec2a0677848f", "name": "Returns an error when an instance of this metadata template is already\npresent on the folder.\n\n* `tuple_already_exists` - An instance of them metadata template already\nexists on the file.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minim6\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present on the metadata\\ntemplate.\\nFor the `global.properties` template this can be a list of zero\\nor more fields, as this template allows for any generic key-value\\npairs to be stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-33b19d19-49fe-444b-ab74-ec2a0677848f" }, { "id": "23d52666-061b-4d3d-99bc-a4bd09513ec0", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"minim6\": {\n \"example\": \"Aaron Levie\",\n \"description\": \"A value for each of the fields that are present on the metadata\\ntemplate.\\nFor the `global.properties` template this can be a list of zero\\nor more fields, as this template allows for any generic key-value\\npairs to be stored in the template.\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-23d52666-061b-4d3d-99bc-a4bd09513ec0" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1b1a6a6c-a379-4a65-9844-671ef5c543fa" }, { "name": "Box Update metadata instance on folder", "id": "a106bc06-dfa9-4955-81cb-1cd31dc8a3b3", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "ff2b1e0d-1c6e-482f-abf6-b08e2b8eec78", "key": "folder_id", "value": "", "description": "(Required) 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`." }, { "id": "fcdedeba-5970-4c8d-a218-a1a2aae1dda1", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "d82ab3bf-74b3-4494-b0ae-8771449475db", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Updates a piece of metadata on a folder.\n\nThe metadata instance can only be updated if the template has already been\napplied to the folder before. When editing metadata, only values that match\nthe metadata template schema will be accepted.\n\nThe update is applied atomically. If any errors occur during the\napplication of the operations, the metadata instance will not be changed." }, "response": [ { "id": "5bb4c5b2-ed42-4971-8829-1bf99fa4eecd", "name": "Returns the updated metadata template instance, with the\ncustom template data included.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\",\n \"$canEdit\": \"\",\n \"$id\": \"\",\n \"$type\": \"\",\n \"$typeVersion\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-5bb4c5b2-ed42-4971-8829-1bf99fa4eecd" }, { "id": "588fb902-11c5-4a6d-8963-a2eeee7a37b1", "name": "Returns an error when the request body is not valid.\n\n* `bad_request` - The request body format is not an array of valid JSON\nPatch objects.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-588fb902-11c5-4a6d-8963-a2eeee7a37b1" }, { "id": "0621530e-eb96-4917-b86b-720dc02f63dd", "name": "Returns an error in some edge cases when the request body is not a valid\narray of JSON Patch items.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-0621530e-eb96-4917-b86b-720dc02f63dd" }, { "id": "467571d1-b79a-4783-b955-d794b28c8659", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json-patch+json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "[\n {\n \"op\": \"remove\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n },\n {\n \"op\": \"add\",\n \"path\": \"\",\n \"value\": \"\",\n \"from\": \"\"\n }\n]", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-467571d1-b79a-4783-b955-d794b28c8659" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-a106bc06-dfa9-4955-81cb-1cd31dc8a3b3" }, { "name": "Box Remove metadata instance from folder", "id": "70272f26-31b7-43c3-8620-3efcd2d43e4d", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "id": "4f765d38-539c-4d6b-8b10-32309e7c0d10", "key": "folder_id", "value": "", "description": "(Required) 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`." }, { "id": "4908fcf2-c77c-490c-a8db-b10754ef00fa", "key": "scope", "value": "enterprise", "description": "(Required) The scope of the metadata template" }, { "id": "2bdfb69f-8080-4954-8b00-c2dd2e15c5fa", "key": "template_key", "value": "", "description": "(Required) The name of the metadata template" } ] }, "description": "Deletes a piece of folder metadata." }, "response": [ { "id": "4755b7b3-48c5-436b-bb87-6c5b82181888", "name": "Returns an empty response when the metadata is\nsuccessfully deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-4755b7b3-48c5-436b-bb87-6c5b82181888" }, { "id": "bf028ad2-36d0-48f7-ba20-690073753f54", "name": "Returned when the request parameters are not valid. This may happen of the\n`scope` is not valid.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-bf028ad2-36d0-48f7-ba20-690073753f54" }, { "id": "0789bc74-2217-4d51-b222-7da8ebc6b89a", "name": "Returns an error when the folder does not have an instance of the metadata\ntemplate applied to it, or when the user does not have access to the\nfolder.\n\n* `instance_not_found` - An instance of the metadata template with the\ngiven `scope` and `templateKey`", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-0789bc74-2217-4d51-b222-7da8ebc6b89a" }, { "id": "1d93f2b1-07b9-4b93-96ce-d753e8d36fbb", "name": "Returned when the method was not allowed. This often happens when the\nfolder ID is not valid or the root folder with ID `0`.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1d93f2b1-07b9-4b93-96ce-d753e8d36fbb" }, { "id": "1d54cdcc-0b1e-4365-8c5b-c9817c82b138", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata/:scope/:template_key", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata", ":scope", ":template_key" ], "variable": [ { "key": "folder_id" }, { "key": "scope" }, { "key": "template_key" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1d54cdcc-0b1e-4365-8c5b-c9817c82b138" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-70272f26-31b7-43c3-8620-3efcd2d43e4d" } ], "id": "41b248da-8c2f-4dd2-9884-688ffbb93e3c", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-41b248da-8c2f-4dd2-9884-688ffbb93e3c" } ], "id": "64976033-b952-4e97-8bff-8b5949e07fd9", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-64976033-b952-4e97-8bff-8b5949e07fd9" }, { "name": "Box List metadata instances on folder", "id": "9d4ea12a-e2cb-4966-9e10-48688c71ae51", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata" ], "variable": [ { "id": "43f7a8b1-6165-43d1-b39d-7a1ce62fc64a", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieves all metadata for a given folder. This can not be used on the root\nfolder with ID `0`." }, "response": [ { "id": "d829bae1-77be-4868-bb04-127ba9418d7c", "name": "Returns all the metadata associated with a folder.\n\nThis API does not support pagination and will therefore always return\nall of the metadata associated to the folder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata" ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"entries\": [\n {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n ],\n \"limit\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d829bae1-77be-4868-bb04-127ba9418d7c" }, { "id": "ed554498-8dc1-49cc-a90c-3cb54069e067", "name": "Returned when the request parameters are not valid.\n\n* `forbidden` - this operation is not allowed on the Root folder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-ed554498-8dc1-49cc-a90c-3cb54069e067" }, { "id": "f4aead7e-0c9e-4ca9-81f5-fdecaa72a10c", "name": "Returned when the user does not have access to the folder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f4aead7e-0c9e-4ca9-81f5-fdecaa72a10c" }, { "id": "914b7df8-90a0-458f-b749-ca434d04f814", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/metadata", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "metadata" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-914b7df8-90a0-458f-b749-ca434d04f814" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9d4ea12a-e2cb-4966-9e10-48688c71ae51" } ], "id": "074027ff-59b8-4510-86e0-5a93b4a5a135", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-074027ff-59b8-4510-86e0-5a93b4a5a135" }, { "name": "watermark", "item": [ { "name": "Box Get watermark for folder", "id": "78bf9775-3f05-4436-a048-6638f3b5aad6", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "id": "85da600d-60d8-4396-82eb-b9ca75e709e6", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieve the watermark for a folder." }, "response": [ { "id": "1afed9e3-8868-48f8-9696-7c977e35feab", "name": "Returns an object containing information about the\nwatermark associated for to this folder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"watermark\": {\n \"created_at\": \"\",\n \"modified_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1afed9e3-8868-48f8-9696-7c977e35feab" }, { "id": "e57dbe67-f975-4e74-9f29-43114f802fef", "name": "Returns an error if the folder does not have a watermark applied.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e57dbe67-f975-4e74-9f29-43114f802fef" }, { "id": "b7a583a7-6710-4349-a57c-14a18ab4ad5c", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b7a583a7-6710-4349-a57c-14a18ab4ad5c" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-78bf9775-3f05-4436-a048-6638f3b5aad6" }, { "name": "Box Apply watermark to folder", "id": "26ea4bc4-6762-46f8-bf00-8e5b2d4b8df9", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "id": "d3843036-ed65-4789-ba7c-bd1d9ddcf2f0", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Applies or update a watermark on a folder." }, "response": [ { "id": "dec61ee6-3445-49fe-95f9-b586d720bdbc", "name": "Returns an updated watermark if a watermark already\nexisted on this folder.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"watermark\": {\n \"created_at\": \"\",\n \"modified_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-dec61ee6-3445-49fe-95f9-b586d720bdbc" }, { "id": "3abca899-d52e-42a2-ac65-ed5e7f6f3a43", "name": "Returns a new watermark if no watermark existed on\nthis folder yet.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"watermark\": {\n \"created_at\": \"\",\n \"modified_at\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-3abca899-d52e-42a2-ac65-ed5e7f6f3a43" }, { "id": "97bd15d6-e303-46a0-ae28-8ac8eee2c807", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"watermark\": {\n \"imprint\": \"default\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-97bd15d6-e303-46a0-ae28-8ac8eee2c807" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-26ea4bc4-6762-46f8-bf00-8e5b2d4b8df9" }, { "name": "Box Remove watermark from folder", "id": "2088a81d-a7c6-4fac-b641-ab01d2ddc067", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "id": "e21f2ccc-dba9-42fc-bdfe-d2aa17c4871c", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Removes the watermark from a folder." }, "response": [ { "id": "78bb377e-2b3a-4848-ae6c-d7011650ef40", "name": "An empty response will be returned when the watermark\nwas successfully deleted.", "originalRequest": { "method": "DELETE", "header": [], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-78bb377e-2b3a-4848-ae6c-d7011650ef40" }, { "id": "cdcb2ef2-1962-4283-afa4-db7816ebc1b0", "name": "Returns an error if the folder did not have\na watermark applied to it", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-cdcb2ef2-1962-4283-afa4-db7816ebc1b0" }, { "id": "c0535e02-e308-463e-a5bf-a89fe32b489a", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id/watermark", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id", "watermark" ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c0535e02-e308-463e-a5bf-a89fe32b489a" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-2088a81d-a7c6-4fac-b641-ab01d2ddc067" } ], "id": "24c8be3e-0969-40c2-aed3-32a8eaec845a", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-24c8be3e-0969-40c2-aed3-32a8eaec845a" }, { "name": "Box Get folder information", "id": "b9098ec6-60ff-4255-94d7-06aab4376faf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "id": "b3db3bbc-884f-481b-b3d3-9c01893cdbfd", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Retrieves details for a folder, including the first 100 entries\nin the folder.\n\nPassing `sort`, `direction`, `offset`, and `limit`\nparameters in query allows you to manage the\nlist of returned\n[folder items](r://folder--full#param-item-collection).\n\nTo fetch more items within the folder, use the\n[Get items in a folder](e://get-folders-id-items) endpoint." }, "response": [ { "id": "330b5f5a-a8bc-466b-884b-c6bb8579d8e5", "name": "Returns a folder, including the first 100 entries in the folder.\nIf you used query parameters like\n`sort`, `direction`, `offset`, or `limit`\nthe *folder items list* will be affected accordingly.\n\nTo fetch more items within the folder, use the\n[Get items i", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-330b5f5a-a8bc-466b-884b-c6bb8579d8e5" }, { "id": "16743d9c-55c2-4de2-982a-1c9f462e17cb", "name": "Returns an empty response when the `If-None-Match` header matches\nthe current `etag` value of the folder. This indicates that the folder\nhas not changed since it was last requested.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Modified", "code": 304, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-16743d9c-55c2-4de2-982a-1c9f462e17cb" }, { "id": "f5f21f23-ec85-480b-b42e-afcfae3f7135", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f5f21f23-ec85-480b-b42e-afcfae3f7135" }, { "id": "78844ed3-46c4-46e4-ad56-c42c65131697", "name": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-78844ed3-46c4-46e4-ad56-c42c65131697" }, { "id": "8b671f03-3a58-44a4-b275-75a96434d2fa", "name": "Returned if the `folder_id` is not in a recognized format.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-8b671f03-3a58-44a4-b275-75a96434d2fa" }, { "id": "13eae4ad-ba82-451b-8a52-90ab4c14a4ff", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "description": "Ensures an item is only returned if it has changed.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `304 Not Modified` if the item has not\nchanged since.", "key": "if-none-match", "value": "" }, { "description": "The URL, and optional password, for the shared link of this item.\n\nThis header can be used to access items that have not been\nexplicitly shared with a user.\n\nUse the format `shared_link=[link]` or if a password is required then\nuse `shared_link=[link]&shared_link_password=[password]`.\n\nThis header can be used on the file or folder shared, as well as on any files\nor folders nested within the item.", "key": "boxapi", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,&sort=id&direction=ASC&offset=0&limit=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.\n\nAdditionally this field can be used to query any metadata\napplied to the file by specifying the `metadata` field as well\nas the scope and key of the template to retrieve, for example\n`?field=metadata.enterprise_12345.contractTemplate`.", "key": "fields", "value": "," }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nThe folder type affects the way the items\nare sorted:\n\n * **Standard folder**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.\n\n * **Root folder**:\n This parameter is not supported\n for marker-based pagination\n on the root folder\n\n (the folder with an `id` of `0`).\n\n * **Shared folder with parent path\n to the associated folder visible to\n the collaborator**:\n Items are always sorted by\n their `type` first, with\n folders listed before files,\n and files listed\n before web links.", "key": "sort", "value": "id" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-13eae4ad-ba82-451b-8a52-90ab4c14a4ff" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b9098ec6-60ff-4255-94d7-06aab4376faf" }, { "name": "Box Update folder", "id": "9cc65e1e-2556-448b-8f15-7ed528dc1686", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "id": "b49ffb2c-caf7-47a4-bbfa-8356daf5085f", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Updates a folder. This can be also be used to move the folder,\ncreate shared links, update collaborations, and more." }, "response": [ { "id": "57ed51d6-c187-4dfc-9567-bd54c2867ad6", "name": "Returns a folder object for the updated folder\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.\n\nThis call will return synchronously. This holds true even when\nmo", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-57ed51d6-c187-4dfc-9567-bd54c2867ad6" }, { "id": "c49115a1-ad48-4b2d-ad8c-7874bf741994", "name": "Returns an error if some of the parameters are missing or\nnot valid, or if a folder lock is preventing a move operation.\n\n* `bad_request` when a parameter is missing or incorrect. This error also\n happens when a password is set for a shared link with an ", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c49115a1-ad48-4b2d-ad8c-7874bf741994" }, { "id": "b4764277-f510-40ee-8ec2-12f5e86d2a62", "name": "Returns an error if the user does not have the required\naccess to perform the action.\n\n* `access_denied_insufficient_permissions`: Returned when the\n user does not have access to the folder or parent folder, or if the\n folder is being moved and a folder", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b4764277-f510-40ee-8ec2-12f5e86d2a62" }, { "id": "3013dbbf-352e-4bb3-87c5-89a840f3cee0", "name": "Returns an error if the folder or parent folder could not be found,\nor the authenticated user does not have access to either folder.\n\n* `not_found` when the authenticated user does not have access\n to the folder or parent folder.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-3013dbbf-352e-4bb3-87c5-89a840f3cee0" }, { "id": "19945fff-4ef1-40e5-a545-a1070932b198", "name": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in progress.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-19945fff-4ef1-40e5-a545-a1070932b198" }, { "id": "e257faae-0aa0-4bb1-892e-d31db17b7d49", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the\nfolder has changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e257faae-0aa0-4bb1-892e-d31db17b7d49" }, { "id": "a40102b5-c6cc-4cb8-b683-ae4569f7e9f0", "name": "Returns an error when the operation takes longer\nthan 60 seconds. The operation will continue after\nthis response has been returned.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-a40102b5-c6cc-4cb8-b683-ae4569f7e9f0" }, { "id": "7b599eed-669a-4a11-a882-03f6e689ce04", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"description\": \"\",\n \"sync_state\": \"not_synced\",\n \"can_non_owners_invite\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"shared_link\": {\n \"access\": \"open\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"tags\": [\n \"\"\n ],\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"collections\": [\n {\n \"id\": \"\",\n \"type\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"\"\n }\n ],\n \"can_non_owners_view_collaborators\": \"\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-7b599eed-669a-4a11-a882-03f6e689ce04" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9cc65e1e-2556-448b-8f15-7ed528dc1686" }, { "name": "Box Delete folder", "id": "d4e3c2a8-8dc2-4cdc-8b13-5da3b389ea41", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "id": "1f31e674-d757-4b05-b56d-fc505a3ff8f3", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Deletes a folder, either permanently or by moving it to\nthe trash." }, "response": [ { "id": "0fa3aa77-8de5-4871-80ce-45ad2a1580a3", "name": "Returns an empty response when the folder is successfully deleted\nor moved to the trash.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "No Content", "code": 204, "_postman_previewlanguage": "text", "header": [], "cookie": [], "responseTime": null, "body": null, "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-0fa3aa77-8de5-4871-80ce-45ad2a1580a3" }, { "id": "59cd6146-3f36-485a-b65f-34a7025e4b91", "name": "Returns an error if the user makes a bad request.\n\n* `folder_not_empty`: Returned if the folder is not empty. Use the\n `recursive` query parameter to recursively delete the folder and\n its contents.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-59cd6146-3f36-485a-b65f-34a7025e4b91" }, { "id": "231ec547-d257-425d-a116-3651d12f3654", "name": "Returns an error if the user does not have the required\naccess to perform the action.\n\n* `access_denied_insufficient_permissions`: Returned when the\n user does not have access to the folder, or when a folder lock has been\n applied to the folder to preve", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-231ec547-d257-425d-a116-3651d12f3654" }, { "id": "aadbedba-2477-49e3-8460-7d725cd0e730", "name": "Returns an error if the folder could not be found,\nor the authenticated user does not have access to the folder.\n\n* `not_found` when the authenticated user does not have access\n to the folder.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-aadbedba-2477-49e3-8460-7d725cd0e730" }, { "id": "56b8bd3c-06e4-409b-9d4a-734438ce9eca", "name": "* `operation_blocked_temporary`: Returned if the folder\n is locked due to another move, copy, delete or restore\n operation in progress.\n\n The operation can be retried at a later point.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-56b8bd3c-06e4-409b-9d4a-734438ce9eca" }, { "id": "81cb79bc-1f80-436e-82f5-c47f005abd25", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the\nfolder has changed since it was last requested.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-81cb79bc-1f80-436e-82f5-c47f005abd25" }, { "id": "042495b0-28fa-4342-b450-93467fe893bb", "name": "Returns an error when the operation takes longer\nthan 60 seconds. The operation will continue after\nthis response has been returned.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Service Unavailable", "code": 503, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-042495b0-28fa-4342-b450-93467fe893bb" }, { "id": "729c0e41-ab50-4c71-85e2-8a075c6688c0", "name": "An unexpected client error.", "originalRequest": { "method": "DELETE", "header": [ { "description": "Ensures this item hasn't recently changed before\nmaking changes.\n\nPass in the item's last observed `etag` value\ninto this header and the endpoint will fail\nwith a `412 Precondition Failed` if it\nhas changed since.", "key": "if-match", "value": "" }, { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/:folder_id?recursive=", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "query": [ { "description": "Delete a folder that is not empty by recursively deleting the\nfolder and all of its content.", "key": "recursive", "value": "" } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-729c0e41-ab50-4c71-85e2-8a075c6688c0" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d4e3c2a8-8dc2-4cdc-8b13-5da3b389ea41" }, { "name": "Box Restore folder", "id": "ec0102f9-3960-4f51-98ba-c1a4a1b1da4a", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "id": "8dbbff8b-fb92-40ff-9383-9d075cd8ecb7", "key": "folder_id", "value": "", "description": "(Required) 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`." } ] }, "description": "Restores a folder that has been moved to the trash.\n\nAn optional new parent ID can be provided to restore the folder to in case the\noriginal folder has been deleted.\n\n# Folder locking\n\nDuring this operation, part of the file tree will be locked, mainly\nthe source folder and all of its descendants, as well as the destination\nfolder.\n\nFor the duration of the operation, no other move, copy, delete, or restore\noperation can performed on any of the locked folders." }, "response": [ { "id": "18ca85bf-8d30-4b1a-a989-18979de0ff27", "name": "Returns a folder object when the folder has been restored.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"value\": \"reference #/components/schemas/TrashFolderRestored not found in the OpenAPI spec\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-18ca85bf-8d30-4b1a-a989-18979de0ff27" }, { "id": "17894108-3fad-4e84-9a28-e6b830f76466", "name": "Returns an error if the user does not have access to the folder\nthe folder is being restored to, or the user does not have permission\nto restore folders from the trash.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-17894108-3fad-4e84-9a28-e6b830f76466" }, { "id": "168f6c64-5e75-458d-87c3-ec9f07475b5d", "name": "Returns an error if the folder is not in the trash.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-168f6c64-5e75-458d-87c3-ec9f07475b5d" }, { "id": "b9563544-db4c-4402-a2be-767a1eff6670", "name": "* Returned an error if there is a folder with the same name\n in the destination folder.\n\n* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in proc", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-b9563544-db4c-4402-a2be-767a1eff6670" }, { "id": "61307cee-7782-4430-8076-65a74590b1db", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/:folder_id?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders", ":folder_id" ], "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.", "key": "fields", "value": "," } ], "variable": [ { "key": "folder_id" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-61307cee-7782-4430-8076-65a74590b1db" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-ec0102f9-3960-4f51-98ba-c1a4a1b1da4a" } ], "id": "4e1dd55c-a2a1-4d9b-bf60-9159e9704515", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-4e1dd55c-a2a1-4d9b-bf60-9159e9704515" }, { "name": "trash", "item": [ { "name": "items", "item": [ { "name": "Box List trashed items", "id": "1308f5bb-04a1-46d0-96e1-8189ed5410bb", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/trash/items?fields=,&limit=&offset=0&usemarker=&marker=&direction=ASC&sort=name", "host": [ "{{baseUrl}}" ], "path": [ "folders", "trash", "items" ], "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.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination.", "key": "sort", "value": "name" } ] }, "description": "Retrieves the files and folders that have been moved\nto the trash.\n\nAny attribute in the full files or folders objects can be passed\nin with the `fields` parameter to retrieve those specific\nattributes that are not returned by default.\n\nThis endpoint defaults to use offset-based pagination, yet also supports\nmarker-based pagination using the `marker` parameter." }, "response": [ { "id": "05833254-98e8-4c34-8803-3dc1996123f1", "name": "Returns a list of items that have been deleted", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/trash/items?fields=,&limit=&offset=0&usemarker=&marker=&direction=ASC&sort=name", "host": [ "{{baseUrl}}" ], "path": [ "folders", "trash", "items" ], "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.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination.", "key": "sort", "value": "name" } ] } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n },\n {\n \"by\": \"\",\n \"direction\": \"ASC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"open\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopiplus\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"base_explorer\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"base_preview\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"co-owner\",\n \"previewer uploader\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"aliqua_1\": {\n \"eu_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut_4\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1cc\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"inf\": {\n \"pariatur09\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"pending\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_preview\",\n \"can_preview\"\n ]\n },\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_download\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"collaborators\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"trashed\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"office_wopiplus\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"annotation_view_self\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n },\n {\n \"scope\": \"item_preview\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"allowed_invitee_roles\": [\n \"viewer uploader\",\n \"previewer\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"in_fb_\": {\n \"aliqua7d\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"consequat_a2\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n },\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"success\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\",\n \"can_download\"\n ]\n }\n ]\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-05833254-98e8-4c34-8803-3dc1996123f1" }, { "id": "95f3a955-5c9a-4dbe-9527-c5039ade2d20", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `invalid_parameter` can appear when the `sort`, `direction` or `offset`\nparameter is provided when using marker based pagination, or when the\n`marker` parameter is provided but `usema", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/trash/items?fields=,&limit=&offset=0&usemarker=&marker=&direction=ASC&sort=name", "host": [ "{{baseUrl}}" ], "path": [ "folders", "trash", "items" ], "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.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination.", "key": "sort", "value": "name" } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-95f3a955-5c9a-4dbe-9527-c5039ade2d20" }, { "id": "7ef23bef-ed45-41ae-95cf-a9f549fa26e6", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/trash/items?fields=,&limit=&offset=0&usemarker=&marker=&direction=ASC&sort=name", "host": [ "{{baseUrl}}" ], "path": [ "folders", "trash", "items" ], "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.", "key": "fields", "value": "," }, { "description": "The maximum number of items to return per page.", "key": "limit", "value": "" }, { "description": "The offset of the item at which to begin the response.\n\nQueries with offset parameter value\nexceeding 10000 will be rejected\nwith a 400 response.", "key": "offset", "value": "0" }, { "description": "Specifies whether to use marker-based pagination instead of\noffset-based pagination. Only one pagination method can\nbe used at a time.\n\nBy setting this value to true, the API will return a `marker` field\nthat can be passed as a parameter to this endpoint to get the next\npage of the response.", "key": "usemarker", "value": "" }, { "description": "Defines the position marker at which to begin returning results. This is\nused when paginating using marker-based pagination.\n\nThis requires `usemarker` to be set to `true`.", "key": "marker", "value": "" }, { "description": "The direction to sort results in. This can be either in alphabetical ascending\n(`ASC`) or descending (`DESC`) order.", "key": "direction", "value": "ASC" }, { "description": "Defines the **second** attribute by which items\nare sorted.\n\nItems are always sorted by their `type` first, with\nfolders listed before files, and files listed\nbefore web links.\n\nThis parameter is not supported when using marker-based pagination.", "key": "sort", "value": "name" } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-7ef23bef-ed45-41ae-95cf-a9f549fa26e6" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1308f5bb-04a1-46d0-96e1-8189ed5410bb" } ], "id": "db73d817-2470-484f-97cb-6be924aba7cb", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-db73d817-2470-484f-97cb-6be924aba7cb" } ], "id": "f70738e7-1e3b-4bbd-8368-e3d5261731e3", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f70738e7-1e3b-4bbd-8368-e3d5261731e3" }, { "name": "{folder_id}#get_shared_link", "item": [ { "name": "Box Get shared link for folder", "id": "cb5a5ffb-39e0-4e8c-af96-a6f66f630e1c", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" }, "description": "Gets the information for a shared link on a folder." }, "response": [ { "id": "8c5bb5bd-e8e3-465f-9513-5074efc8b406", "name": "Returns the base representation of a folder with the\nadditional shared link information.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-8c5bb5bd-e8e3-465f-9513-5074efc8b406" }, { "id": "728bf3f8-c03e-4464-bb49-0707dd6c8990", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-728bf3f8-c03e-4464-bb49-0707dd6c8990" }, { "id": "3fe7961a-4172-4812-b75c-7f29a9d2820e", "name": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-3fe7961a-4172-4812-b75c-7f29a9d2820e" }, { "id": "02d42b90-3123-4fd6-85b2-3eefc6b36b1c", "name": "Returned if the `folder_id` is not in a recognized format.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-02d42b90-3123-4fd6-85b2-3eefc6b36b1c" }, { "id": "5567a2f6-0fa7-48d6-8274-8f48300dd00a", "name": "An unexpected client error.", "originalRequest": { "method": "GET", "header": [ { "key": "Accept", "value": "application/json" } ], "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#get_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "get_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-5567a2f6-0fa7-48d6-8274-8f48300dd00a" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-cb5a5ffb-39e0-4e8c-af96-a6f66f630e1c" } ], "id": "645d678b-00a2-4caa-b7d2-8b1a0c505334", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-645d678b-00a2-4caa-b7d2-8b1a0c505334" }, { "name": "{folder_id}#add_shared_link", "item": [ { "name": "Box Add shared link to folder", "id": "a340bc58-0a85-4ded-b473-8aea80686ed8", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" }, "description": "Adds a shared link to a folder." }, "response": [ { "id": "d79e08c3-1379-4d9d-9463-a82d8039f523", "name": "Returns the base representation of a folder with a new shared\nlink attached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d79e08c3-1379-4d9d-9463-a82d8039f523" }, { "id": "d9bbae46-d654-4d56-b5f1-3e5d2dcdcac2", "name": "Returned when there is an incorrect permission combination", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-d9bbae46-d654-4d56-b5f1-3e5d2dcdcac2" }, { "id": "cdadf0b0-bbbe-4d97-b993-2a8bcdd710a5", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-cdadf0b0-bbbe-4d97-b993-2a8bcdd710a5" }, { "id": "f73b8c1a-16c8-41e5-a49c-59b6b2419fab", "name": "Returned if the user does not have all the permissions to complete the\nupdate.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-f73b8c1a-16c8-41e5-a49c-59b6b2419fab" }, { "id": "c322ee61-5d93-469e-90af-fd1af3a24a8a", "name": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c322ee61-5d93-469e-90af-fd1af3a24a8a" }, { "id": "c15928bf-9a05-4e67-ba9b-1abc678fa4b3", "name": "Returned if the `folder_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c15928bf-9a05-4e67-ba9b-1abc678fa4b3" }, { "id": "96fcc408-fcf7-4f4d-909c-edc7a2624be9", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the folder\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-96fcc408-fcf7-4f4d-909c-edc7a2624be9" }, { "id": "114cdb8a-f472-4d81-ab62-3818f772d89a", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"company\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#add_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "add_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-114cdb8a-f472-4d81-ab62-3818f772d89a" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-a340bc58-0a85-4ded-b473-8aea80686ed8" } ], "id": "785b23f9-80ce-4e2f-8b18-c6c310eadaa5", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-785b23f9-80ce-4e2f-8b18-c6c310eadaa5" }, { "name": "{folder_id}#update_shared_link", "item": [ { "name": "Box Update shared link on folder", "id": "ade2b084-e435-4935-9132-4e67a6f1b2cf", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" }, "description": "Updates a shared link on a folder." }, "response": [ { "id": "908e050d-4424-4f64-86a6-b1fc737e0d2a", "name": "Returns a basic representation of the folder, with the updated shared\nlink attached.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-908e050d-4424-4f64-86a6-b1fc737e0d2a" }, { "id": "7391926b-f217-4c2f-8af5-422eae641a01", "name": "Returned when there is an incorrect permission combination", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-7391926b-f217-4c2f-8af5-422eae641a01" }, { "id": "e2cf17f7-7f6e-45d5-b3f5-d9935a566d9a", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e2cf17f7-7f6e-45d5-b3f5-d9935a566d9a" }, { "id": "e6af690a-85c2-4ce7-9aeb-9ac20d000db5", "name": "Returned if the user does not have all the permissions to complete the\nupdate.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e6af690a-85c2-4ce7-9aeb-9ac20d000db5" }, { "id": "3dccff5e-ba5d-45a6-9938-d52d490e0839", "name": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-3dccff5e-ba5d-45a6-9938-d52d490e0839" }, { "id": "1b4d6fc2-ec3e-4430-8b2a-8706efd92d9b", "name": "Returned if the `folder_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-1b4d6fc2-ec3e-4430-8b2a-8706efd92d9b" }, { "id": "9d57dacf-8788-479b-8e71-70cd3bfbac14", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the folder\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9d57dacf-8788-479b-8e71-70cd3bfbac14" }, { "id": "c6b08c21-d2e8-4dcf-8b31-7cd3d45a2b24", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {\n \"access\": \"collaborators\",\n \"password\": \"\",\n \"vanity_name\": \"\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n }\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#update_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "update_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-c6b08c21-d2e8-4dcf-8b31-7cd3d45a2b24" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-ade2b084-e435-4935-9132-4e67a6f1b2cf" } ], "id": "389b2e02-8689-445b-9dc3-4930be3d6aad", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-389b2e02-8689-445b-9dc3-4930be3d6aad" }, { "name": "{folder_id}#remove_shared_link", "item": [ { "name": "Box Remove shared link from folder", "id": "69abb08d-07e3-41fc-8310-ff151ac94d36", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" }, "description": "Removes a shared link from a folder." }, "response": [ { "id": "4b4a686b-6227-4d33-adef-88c24382b3a3", "name": "Returns a basic representation of a folder, with the shared link removed.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "OK", "code": 200, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-4b4a686b-6227-4d33-adef-88c24382b3a3" }, { "id": "ed77c71e-b839-40de-bd45-8dfd7ea168b1", "name": "Returned when the access token provided in the `Authorization` header\nis not recognized or not provided.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Unauthorized", "code": 401, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-ed77c71e-b839-40de-bd45-8dfd7ea168b1" }, { "id": "9823bb2a-a382-4533-9fee-3ddb163d08c0", "name": "Returned if the user does not have all the permissions to complete the\nupdate.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9823bb2a-a382-4533-9fee-3ddb163d08c0" }, { "id": "5c1deb37-5359-42aa-967b-1eb8fff5743a", "name": "Returned if the folder is not found, or the user does not\nhave access to the folder.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-5c1deb37-5359-42aa-967b-1eb8fff5743a" }, { "id": "969dfb58-e6fc-468d-bf32-b64e31e4a2c8", "name": "Returned if the `folder_id` is not in a recognized format.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Method Not Allowed", "code": 405, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-969dfb58-e6fc-468d-bf32-b64e31e4a2c8" }, { "id": "19981367-9fc3-4836-bbfb-e2c5044d3c4c", "name": "Returns an error when the `If-Match` header does not match\nthe current `etag` value of the folder. This indicates that the folder\nhas changed since it was last requested.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Precondition Failed", "code": 412, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-19981367-9fc3-4836-bbfb-e2c5044d3c4c" }, { "id": "a2ee8bae-82d0-46e1-8cb3-27b081c3cfcc", "name": "An unexpected client error.", "originalRequest": { "method": "PUT", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"shared_link\": {}\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders/{{folder_id}}?fields=#remove_shared_link", "host": [ "{{baseUrl}}" ], "path": [ "folders", "{{folder_id}}" ], "query": [ { "description": "(Required) Explicitly request the `shared_link` fields\nto be returned for this item.", "key": "fields", "value": "" } ], "hash": "remove_shared_link" } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-a2ee8bae-82d0-46e1-8cb3-27b081c3cfcc" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-69abb08d-07e3-41fc-8310-ff151ac94d36" } ], "id": "895c4f3b-1c33-43f6-9975-19bd7191b084", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-895c4f3b-1c33-43f6-9975-19bd7191b084" }, { "name": "Box Create folder", "id": "317c8de4-ae13-4133-a5cd-828db606b069", "protocolProfileBehavior": { "disableBodyPruning": true }, "request": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] }, "description": "Creates a new empty folder within the specified parent folder." }, "response": [ { "id": "8a356cd4-23a8-42ed-a82c-1619a58d710a", "name": "Returns a folder object.\n\nNot all available fields are returned by default. Use the\n[fields](#param-fields) query parameter to explicitly request\nany specific fields.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] } }, "status": "Created", "code": 201, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"company\",\n \"effective_permission\": \"can_preview\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"folder_upload_email\": {\n \"access\": \"collaborators\",\n \"email\": \"\"\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"active\",\n \"item_collection\": {\n \"total_count\": \"\",\n \"limit\": \"\",\n \"offset\": \"\",\n \"order\": [\n {\n \"by\": \"\",\n \"direction\": \"DESC\"\n }\n ],\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"file\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\",\n \"sha1\": \"\",\n \"file_version\": {\n \"id\": \"\",\n \"type\": \"file_version\",\n \"sha1\": \"\"\n },\n \"description\": \"\",\n \"size\": \"\",\n \"path_collection\": {\n \"total_count\": \"\",\n \"entries\": [\n {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n ]\n },\n \"created_at\": \"\",\n \"modified_at\": \"\",\n \"trashed_at\": \"\",\n \"purged_at\": \"\",\n \"content_created_at\": \"\",\n \"content_modified_at\": \"\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"modified_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"owned_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"shared_link\": {\n \"url\": \"\",\n \"effective_access\": \"collaborators\",\n \"effective_permission\": \"can_edit\",\n \"is_password_enabled\": \"\",\n \"download_count\": \"\",\n \"preview_count\": \"\",\n \"download_url\": \"\",\n \"vanity_url\": \"\",\n \"vanity_name\": \"\",\n \"access\": \"company\",\n \"unshared_at\": \"\",\n \"permissions\": {\n \"can_download\": \"\",\n \"can_preview\": \"\",\n \"can_edit\": \"\"\n }\n },\n \"parent\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n },\n \"item_status\": \"deleted\",\n \"version_number\": \"\",\n \"comment_count\": \"\",\n \"permissions\": {\n \"can_annotate\": \"\",\n \"can_comment\": \"\",\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_preview\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\",\n \"can_view_annotations_all\": \"\",\n \"can_view_annotations_self\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"lock\": {\n \"id\": \"\",\n \"type\": \"lock\",\n \"created_by\": {\n \"type\": \"user\",\n \"id\": \"\",\n \"name\": \"\",\n \"login\": \"\"\n },\n \"created_at\": \"\",\n \"expired_at\": \"\",\n \"is_download_prevented\": \"\",\n \"app_type\": \"gsuite\"\n },\n \"extension\": \"\",\n \"is_package\": \"\",\n \"expiring_embed_link\": {\n \"access_token\": \"\",\n \"expires_in\": \"\",\n \"token_type\": \"bearer\",\n \"restricted_to\": [\n {\n \"scope\": \"item_share\",\n \"object\": {\n \"id\": \"\",\n \"type\": \"folder\",\n \"etag\": \"\",\n \"sequence_id\": \"\",\n \"name\": \"\"\n }\n }\n ],\n \"url\": \"\"\n },\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": false,\n \"allowed_invitee_roles\": [\n \"editor\"\n ],\n \"is_externally_owned\": \"\",\n \"has_collaborations\": \"\",\n \"metadata\": {\n \"et0\": {\n \"consecteturf\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"laboredd3\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"anim_373\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"consequat_3e\": {\n \"in6\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"labore_d9\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"expires_at\": \"\",\n \"representations\": {\n \"entries\": [\n {\n \"content\": {\n \"url_template\": \"\"\n },\n \"info\": {\n \"url\": \"\"\n },\n \"properties\": {\n \"dimensions\": \"\",\n \"paged\": \"\",\n \"thumb\": \"\"\n },\n \"representation\": \"\",\n \"status\": {\n \"state\": \"none\"\n }\n }\n ]\n },\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n },\n \"uploader_display_name\": \"\",\n \"disposition_at\": \"\",\n \"shared_link_permission_options\": [\n \"can_edit\"\n ]\n }\n ]\n },\n \"sync_state\": \"not_synced\",\n \"has_collaborations\": \"\",\n \"permissions\": {\n \"can_delete\": \"\",\n \"can_download\": \"\",\n \"can_invite_collaborator\": \"\",\n \"can_rename\": \"\",\n \"can_set_share_access\": \"\",\n \"can_share\": \"\",\n \"can_upload\": \"\"\n },\n \"tags\": [\n \"\"\n ],\n \"can_non_owners_invite\": \"\",\n \"is_externally_owned\": \"\",\n \"metadata\": {\n \"quisff\": {\n \"veniama_\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"sint_909\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"elit5eb\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"in85e\": {\n \"ipsum3ff\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"mollit_1a\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"dolor_8\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"culpa10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"amet_59e\": {\n \"reprehenderitce\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"adipisicing_70\": {\n \"occaecat10\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"Excepteur7\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n },\n \"ut221\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n },\n \"ea_e\": {\n \"elit_031\": {\n \"$parent\": \"\",\n \"$template\": \"\",\n \"$scope\": \"\",\n \"$version\": \"\"\n }\n }\n },\n \"is_collaboration_restricted_to_enterprise\": \"\",\n \"allowed_shared_link_access_levels\": [\n \"open\"\n ],\n \"allowed_invitee_roles\": [\n \"previewer\"\n ],\n \"watermark_info\": {\n \"is_watermarked\": \"\"\n },\n \"is_accessible_via_shared_link\": true,\n \"can_non_owners_view_collaborators\": \"\",\n \"classification\": {\n \"name\": \"\",\n \"definition\": \"\",\n \"color\": \"\"\n }\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-8a356cd4-23a8-42ed-a82c-1619a58d710a" }, { "id": "9ce54157-6400-4bda-a9c9-b11c4fb7836d", "name": "Returns an error if some of the parameters are missing or\nnot valid.\n\n* `bad_request` when a parameter is missing or incorrect.\n* `item_name_too_long` when the folder name is too long.\n* `item_name_invalid` when the folder name contains\n non-valid charac", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] } }, "status": "Bad Request", "code": 400, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9ce54157-6400-4bda-a9c9-b11c4fb7836d" }, { "id": "26da8b4c-2029-4f09-a4f1-76139d62cfbc", "name": "Returns an error if the user does not have the required\naccess to perform the action. This might be because they\ndon't have access to the folder or parent folder, or because\nthe application does not have permission to write files and\nfolders.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] } }, "status": "Forbidden", "code": 403, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-26da8b4c-2029-4f09-a4f1-76139d62cfbc" }, { "id": "9d02d447-35b4-44fe-a371-45e2df46cf16", "name": "Returns an error if the parent folder could not be found,\nor the authenticated user does not have access to the parent\nfolder.\n\n* `not_found` when the authenticated user does not have access\n to the parent folder", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] } }, "status": "Not Found", "code": 404, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-9d02d447-35b4-44fe-a371-45e2df46cf16" }, { "id": "6b85d3c0-0981-49e3-9a07-d336ecd82b32", "name": "* `operation_blocked_temporary`: Returned if either of the destination\n or source folders is locked due to another move, copy, delete or\n restore operation in process.\n\n The operation can be retried at a later point.\n\n* `item_name_in_use`: Returned if ", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] } }, "status": "Conflict", "code": 409, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-6b85d3c0-0981-49e3-9a07-d336ecd82b32" }, { "id": "e4836ade-9a55-48b0-9e9d-46e2819e350a", "name": "An unexpected client error.", "originalRequest": { "method": "POST", "header": [ { "key": "Content-Type", "value": "application/json" }, { "key": "Accept", "value": "application/json" } ], "body": { "mode": "raw", "raw": "{\n \"name\": \"\",\n \"parent\": {\n \"id\": \"\"\n },\n \"folder_upload_email\": {\n \"access\": \"open\"\n },\n \"sync_state\": \"not_synced\"\n}", "options": { "raw": { "headerFamily": "json", "language": "json" } } }, "url": { "raw": "{{baseUrl}}/folders?fields=,", "host": [ "{{baseUrl}}" ], "path": [ "folders" ], "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.", "key": "fields", "value": "," } ] } }, "status": "Internal Server Error", "code": 500, "_postman_previewlanguage": "json", "header": [ { "key": "Content-Type", "value": "application/json" } ], "cookie": [], "responseTime": null, "body": "{\n \"type\": \"error\",\n \"status\": \"\",\n \"code\": \"created\",\n \"message\": \"\",\n \"context_info\": {\n \"message\": \"\"\n },\n \"help_url\": \"\",\n \"request_id\": \"\"\n}", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-e4836ade-9a55-48b0-9e9d-46e2819e350a" } ], "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-317c8de4-ae13-4133-a5cd-828db606b069" } ], "id": "a829c8dd-069c-4188-b5d3-5d670b2d876c", "createdAt": "2026-07-28T01:16:14.000Z", "updatedAt": "2026-07-28T01:16:14.000Z", "uid": "35240-a829c8dd-069c-4188-b5d3-5d670b2d876c" } ], "variable": [ { "key": "baseUrl", "value": "/" }, { "key": "folder_id", "value": "" } ] }