# Box Platform API API

> Box Platform API API on Apizie: 295 endpoints (Authorize user, Request access token, Refresh access token, Revoke access token, …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:box/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:box`
- Category: Cloud
- Status: byok
- Source: https://developer.box.com
- Page: https://zieapi.vercel.app/api/cloud/box
- OpenAPI: https://zieapi.vercel.app/api/cloud/box/openapi.json

[Box Platform](https://developer.box.com) provides functionality to provide access to content stored within [Box](https://box.com). It provides endpoints for basic manipulation of files and folders, management of users…

## Endpoints

### Authorize user
`GET https://zieapi.vercel.app/v1/cloud:box/get-authorize` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| response_type | string | yes | The type of response we'd like to receive. |
| client_id | string | yes | The Client ID of the application that is requesting to authenticate the user. To get the Client ID for your application, log in to your… |
| redirect_uri | string | no | The URI to which Box redirects the browser after the user has granted or denied the application permission. This URI match one of the… |
| state | string | no | A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be… |
| scope | string | no | A space-separated list of application scopes you'd like to authenticate the user for. This defaults to all the scopes configured for the… |

### Request access token
`POST https://zieapi.vercel.app/v1/cloud:box/post-oauth2-token` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Refresh access token
`POST https://zieapi.vercel.app/v1/cloud:box/post-oauth2-token-refresh` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Revoke access token
`POST https://zieapi.vercel.app/v1/cloud:box/post-oauth2-revoke` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | Form fields as a JSON object |

### Get file information
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| if-none-match | string | no | Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will… |
| boxapi | string | no | The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly… |
| x-rep-hints | string | no | A header required to request specific `representations` of a file. Use this in combination with the `fields` query parameter to request a… |

### Restore file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### Update file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |
| body | object | no | JSON request body |

### Delete file
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |

### List file app item associations
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-app-item-associations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| limit | integer | no | The maximum number of items to return per page. |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| application_type | string | no | If given, only return app items for this application type. |

### Download file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| range | string | no | The byte range of the content to download. The format `bytes={start_byte}-{end_byte}` can be used to specify what section of the file to… |
| boxapi | string | no | The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly… |
| version | string | no | The file version to download. |
| access_token | string | no | An optional access token that can be used to pre-authenticate this request, which means that a download link can be shared with a browser… |

### Upload file version
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| content-md5 | string | no | An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit. |
| body | object | no | Form fields as a JSON object |

### Upload file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-content` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| content-md5 | string | no | An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit. |
| body | object | no | Form fields as a JSON object |

### Create upload session
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-upload-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Create upload session for existing file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-upload-sessions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| body | object | no | JSON request body |

### Get upload session
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-upload-sessions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| upload_session_id | string | yes | The ID of the upload session. |

### Upload part of file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-upload-sessions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| upload_session_id | string | yes | The ID of the upload session. |
| digest | string | yes | The [RFC3230][1] message digest of the chunk uploaded. `SHA-1` and `SHA-512` ([RFC5843][2]) are supported. The digest must be base64… |
| content-range | string | yes | The byte range of the chunk. Must not overlap with the range of a part already uploaded this session. Each part’s size must be exactly… |

### Remove upload session
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-upload-sessions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| upload_session_id | string | yes | The ID of the upload session. |

### List parts
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-upload-sessions-id-parts` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| upload_session_id | string | yes | The ID of the upload session. |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |
| limit | integer | no | The maximum number of items to return per page. |

### Plan upload session
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-upload-sessions-id-plan` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| upload_session_id | string | yes | The ID of the upload session. |
| body | object | no | JSON request body |

### Commit upload session
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-upload-sessions-id-commit` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| upload_session_id | string | yes | The ID of the upload session. |
| digest | string | yes | The [RFC3230][1] message digest of the whole file. Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |
| if-none-match | string | no | Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will… |
| body | object | no | JSON request body |

### Copy file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-copy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### Get file thumbnail
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-thumbnail-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| extension | string | yes | The file format for the thumbnail. |
| min_height | integer | no | The minimum height of the thumbnail. |
| min_width | integer | no | The minimum width of the thumbnail. |
| max_height | integer | no | The maximum height of the thumbnail. |
| max_width | integer | no | The maximum width of the thumbnail. |

### List file collaborations
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-collaborations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| limit | integer | no | The maximum number of items to return per page. |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |

### List file comments
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| limit | integer | no | The maximum number of items to return per page. |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |

### List tasks on file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Get trashed file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-trash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |

### Permanently remove file
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id-trash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### List all file versions
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-versions` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| limit | integer | no | The maximum number of items to return per page. |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |

### Get file version
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-versions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| file_version_id | string | yes | The ID of the file version. |

### Restore file version
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-versions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| file_version_id | string | yes | The ID of the file version. |
| body | object | no | JSON request body |

### Remove file version
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id-versions-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| file_version_id | string | yes | The ID of the file version. |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |

### Promote file version
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-versions-current` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### List metadata instances on file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| view | string | no | Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve… |

### Get classification on file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-metadata-enterprise-security-classification-6-v` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Add classification to file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-metadata-enterprise-security-classification-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| body | object | no | JSON request body |

### Update classification on file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-metadata-enterprise-security-classification-6-v` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| body | object | no | JSON request body |

### Remove classification from file
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id-metadata-enterprise-security-classification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Get metadata instance on file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |
| view | string | no | Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve… |

### Create metadata instance on file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |
| body | object | no | JSON request body |

### Update metadata instance on file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |
| body | object | no | JSON request body |

### Remove metadata instance from file
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |

### List Box Skill cards on file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-metadata-global-box-skills-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Create Box Skill cards on file
`POST https://zieapi.vercel.app/v1/cloud:box/post-files-id-metadata-global-box-skills-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| body | object | no | JSON request body |

### Update Box Skill cards on file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-metadata-global-box-skills-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| body | object | no | JSON request body |

### Remove Box Skill cards from file
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id-metadata-global-box-skills-cards` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Get watermark on file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Apply watermark to file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| body | object | no | JSON request body |

### Remove watermark from file
`POST https://zieapi.vercel.app/v1/cloud:box/delete-files-id-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |

### Get file request
`GET https://zieapi.vercel.app/v1/cloud:box/get-file-requests-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_request_id | string | yes | The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in… |

### Update file request
`POST https://zieapi.vercel.app/v1/cloud:box/put-file-requests-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_request_id | string | yes | The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |
| body | object | no | JSON request body |

### Delete file request
`POST https://zieapi.vercel.app/v1/cloud:box/delete-file-requests-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_request_id | string | yes | The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in… |

### Copy file request
`POST https://zieapi.vercel.app/v1/cloud:box/post-file-requests-id-copy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_request_id | string | yes | The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in… |
| body | object | no | JSON request body |

### Get folder information
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| if-none-match | string | no | Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will… |
| boxapi | string | no | The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly… |
| sort | string | no | Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**:… |
| direction | string | no | The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order. |
| offset | integer | no | The offset of the item at which to begin the response. Offset-based pagination is not guaranteed to work reliably for high offset values… |
| limit | integer | no | The maximum number of items to return per page. |

### Restore folder
`POST https://zieapi.vercel.app/v1/cloud:box/post-folders-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### Update folder
`POST https://zieapi.vercel.app/v1/cloud:box/put-folders-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |
| body | object | no | JSON request body |

### Delete folder
`POST https://zieapi.vercel.app/v1/cloud:box/delete-folders-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| if-match | string | no | Ensures this item hasn't recently changed before making changes. Pass in the item's last observed `etag` value into this header and the… |
| recursive | boolean | no | Delete a folder that is not empty by recursively deleting the folder and all of its content. |

### List folder app item associations
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-app-item-associations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| limit | integer | no | The maximum number of items to return per page. |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| application_type | string | no | If given, returns only app items for this application type. |

### List items in folder
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| usemarker | boolean | no | Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By… |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| offset | integer | no | The offset of the item at which to begin the response. Offset-based pagination is not guaranteed to work reliably for high offset values… |
| limit | integer | no | The maximum number of items to return per page. |
| boxapi | string | no | The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly… |
| sort | string | no | Defines the **second** attribute by which items are sorted. The folder type affects the way the items are sorted: * **Standard folder**:… |
| direction | string | no | The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order. |

### Create folder
`POST https://zieapi.vercel.app/v1/cloud:box/post-folders` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### Copy folder
`POST https://zieapi.vercel.app/v1/cloud:box/post-folders-id-copy` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier of the folder to copy. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### List folder collaborations
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-collaborations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| limit | integer | no | The maximum number of items to return per page. |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |

### Get trashed folder
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-trash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |

### Permanently remove folder
`POST https://zieapi.vercel.app/v1/cloud:box/delete-folders-id-trash` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |

### List metadata instances on folder
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| view | string | no | Taxonomy field values are returned in `API view` by default, meaning the value is represented with a taxonomy node identifier. To retrieve… |

### Get classification on folder
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-metadata-enterprise-security-classification-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |

### Add classification to folder
`POST https://zieapi.vercel.app/v1/cloud:box/post-folders-id-metadata-enterprise-security-classification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| body | object | no | JSON request body |

### Update classification on folder
`POST https://zieapi.vercel.app/v1/cloud:box/put-folders-id-metadata-enterprise-security-classification-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| body | object | no | JSON request body |

### Remove classification from folder
`POST https://zieapi.vercel.app/v1/cloud:box/delete-folders-id-metadata-enterprise-security-classificatio` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |

### Get metadata instance on folder
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |

### Create metadata instance on folder
`POST https://zieapi.vercel.app/v1/cloud:box/post-folders-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |
| body | object | no | JSON request body |

### Update metadata instance on folder
`POST https://zieapi.vercel.app/v1/cloud:box/put-folders-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |
| body | object | no | JSON request body |

### Remove metadata instance from folder
`POST https://zieapi.vercel.app/v1/cloud:box/delete-folders-id-metadata-id-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |

### List trashed items
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-trash-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| limit | integer | no | The maximum number of items to return per page. |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |
| usemarker | boolean | no | Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By… |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| direction | string | no | The direction to sort results in. This can be either in alphabetical ascending (`ASC`) or descending (`DESC`) order. |
| sort | string | no | Defines the **second** attribute by which items are sorted. Items are always sorted by their `type` first, with folders listed before… |

### Get watermark for folder
`GET https://zieapi.vercel.app/v1/cloud:box/get-folders-id-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |

### Apply watermark to folder
`POST https://zieapi.vercel.app/v1/cloud:box/put-folders-id-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |
| body | object | no | JSON request body |

### Remove watermark from folder
`POST https://zieapi.vercel.app/v1/cloud:box/delete-folders-id-watermark` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |

### List folder locks
`GET https://zieapi.vercel.app/v1/cloud:box/get-folder-locks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and… |

### Create folder lock
`POST https://zieapi.vercel.app/v1/cloud:box/post-folder-locks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Delete folder lock
`POST https://zieapi.vercel.app/v1/cloud:box/delete-folder-locks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_lock_id | string | yes | The ID of the folder lock. |

### Find metadata template by instance ID
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-templates` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| metadata_instance_id | string | yes | The ID of an instance of the metadata template to find. |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| limit | integer | no | The maximum number of items to return per page. |

### List all classifications
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-templates-enterprise-security-classification-6` (byok)

### Add classification
`POST https://zieapi.vercel.app/v1/cloud:box/put-metadata-templates-enterprise-security-classification-6` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Update classification
`POST https://zieapi.vercel.app/v1/cloud:box/put-metadata-templates-enterprise-security-classification-6-2` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get metadata template by name
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-templates-id-id-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |

### Update metadata template
`POST https://zieapi.vercel.app/v1/cloud:box/put-metadata-templates-id-id-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |
| body | object | no | JSON request body |

### Remove metadata template
`POST https://zieapi.vercel.app/v1/cloud:box/delete-metadata-templates-id-id-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| scope | string | yes | The scope of the metadata template. |
| template_key | string | yes | The name of the metadata template. |

### Get metadata template by ID
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-templates-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| template_id | string | yes | The ID of the template. |

### List all global metadata templates
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-templates-global` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| limit | integer | no | The maximum number of items to return per page. |

### List all metadata templates for enterprise
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-templates-enterprise` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| limit | integer | no | The maximum number of items to return per page. |

### Create metadata template
`POST https://zieapi.vercel.app/v1/cloud:box/post-metadata-templates-schema` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Add initial classifications
`POST https://zieapi.vercel.app/v1/cloud:box/post-metadata-templates-schema-classifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### List metadata cascade policies
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-cascade-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| folder_id | string | yes | Specifies which folder to return policies for. This can not be used on the root folder with ID `0`. |
| owner_enterprise_id | string | no | The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise. |
| marker | string | no | Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires… |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |

### Create metadata cascade policy
`POST https://zieapi.vercel.app/v1/cloud:box/post-metadata-cascade-policies` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get metadata cascade policy
`GET https://zieapi.vercel.app/v1/cloud:box/get-metadata-cascade-policies-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| metadata_cascade_policy_id | string | yes | The ID of the metadata cascade policy. |

### Remove metadata cascade policy
`POST https://zieapi.vercel.app/v1/cloud:box/delete-metadata-cascade-policies-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| metadata_cascade_policy_id | string | yes | The ID of the metadata cascade policy. |

### Force-apply metadata cascade policy to folder
`POST https://zieapi.vercel.app/v1/cloud:box/post-metadata-cascade-policies-id-apply` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| metadata_cascade_policy_id | string | yes | The ID of the cascade policy to force-apply. |
| body | object | no | JSON request body |

### Query files/folders by metadata
`POST https://zieapi.vercel.app/v1/cloud:box/post-metadata-queries-execute-read` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get comment
`GET https://zieapi.vercel.app/v1/cloud:box/get-comments-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The ID of the comment. |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |

### Update comment
`POST https://zieapi.vercel.app/v1/cloud:box/put-comments-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The ID of the comment. |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### Remove comment
`POST https://zieapi.vercel.app/v1/cloud:box/delete-comments-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| comment_id | string | yes | The ID of the comment. |

### Create comment
`POST https://zieapi.vercel.app/v1/cloud:box/post-comments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| body | object | no | JSON request body |

### Get collaboration
`GET https://zieapi.vercel.app/v1/cloud:box/get-collaborations-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collaboration_id | string | yes | The ID of the collaboration. |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |

### Update collaboration
`POST https://zieapi.vercel.app/v1/cloud:box/put-collaborations-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collaboration_id | string | yes | The ID of the collaboration. |
| body | object | no | JSON request body |

### Remove collaboration
`POST https://zieapi.vercel.app/v1/cloud:box/delete-collaborations-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| collaboration_id | string | yes | The ID of the collaboration. |

### List pending collaborations
`GET https://zieapi.vercel.app/v1/cloud:box/get-collaborations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| status | string | yes | The status of the collaborations to retrieve. |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |
| limit | integer | no | The maximum number of items to return per page. |

### Create collaboration
`POST https://zieapi.vercel.app/v1/cloud:box/post-collaborations` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| notify | boolean | no | Determines if users should receive email notification for the action performed. |
| body | object | no | JSON request body |

### Search for content
`GET https://zieapi.vercel.app/v1/cloud:box/get-search` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| query | string | no | The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the… |
| scope | string | no | Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope… |
| file_extensions | array | no | Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file… |
| created_at_range | array | no | Limits the search results to any items created within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.… |
| updated_at_range | array | no | Limits the search results to any items updated within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.… |
| size_range | array | no | Limits the search results to any items with a size within a given file size range. This applied to files and folders. Size ranges are… |
| owner_user_ids | array | no | Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs. The… |
| recent_updater_user_ids | array | no | Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs.… |
| ancestor_folder_ids | array | no | Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will… |
| content_types | array | no | Limits the search results to any items that match the search query for a specific part of the file, for example the file description.… |
| type | string | no | Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any… |
| trash_content | string | no | Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in… |
| mdfilters | array | no | Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly… |
| sort | string | no | Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is… |
| direction | string | no | Defines the direction in which search results are ordered. This API defaults to returning items in descending (`DESC`) order unless this… |
| limit | integer | no | Defines the maximum number of items to return as part of a page of results. |
| include_recent_shared_links | boolean | no | Defines whether the search results should include any items that the user recently accessed through a shared link. When this parameter has… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| offset | integer | no | The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400… |
| deleted_user_ids | array | no | Limits the search results to items that were deleted by the given list of users, defined as a list of comma separated user IDs. The… |
| deleted_at_range | array | no | Limits the search results to any items deleted within a given date range. Date ranges are defined as comma separated RFC3339 timestamps.… |

### Create task
`POST https://zieapi.vercel.app/v1/cloud:box/post-tasks` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get task
`GET https://zieapi.vercel.app/v1/cloud:box/get-tasks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | string | yes | The ID of the task. |

### Update task
`POST https://zieapi.vercel.app/v1/cloud:box/put-tasks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | string | yes | The ID of the task. |
| body | object | no | JSON request body |

### Remove task
`POST https://zieapi.vercel.app/v1/cloud:box/delete-tasks-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | string | yes | The ID of the task. |

### List task assignments
`GET https://zieapi.vercel.app/v1/cloud:box/get-tasks-id-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_id | string | yes | The ID of the task. |

### Assign task
`POST https://zieapi.vercel.app/v1/cloud:box/post-task-assignments` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| body | object | no | JSON request body |

### Get task assignment
`GET https://zieapi.vercel.app/v1/cloud:box/get-task-assignments-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_assignment_id | string | yes | The ID of the task assignment. |

### Update task assignment
`POST https://zieapi.vercel.app/v1/cloud:box/put-task-assignments-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_assignment_id | string | yes | The ID of the task assignment. |
| body | object | no | JSON request body |

### Unassign task
`POST https://zieapi.vercel.app/v1/cloud:box/delete-task-assignments-id` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| task_assignment_id | string | yes | The ID of the task assignment. |

### Find file for shared link
`GET https://zieapi.vercel.app/v1/cloud:box/get-shared-items` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| if-none-match | string | no | Ensures an item is only returned if it has changed. Pass in the item's last observed `etag` value into this header and the endpoint will… |
| fields | array | no | A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a… |
| boxapi | string | yes | A header containing the shared link and optional password for the shared link. The format for this header is as follows:… |

### Get shared link for file
`GET https://zieapi.vercel.app/v1/cloud:box/get-files-id-get-shared-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | string | yes | Explicitly request the `shared_link` fields to be returned for this item. |

### Add shared link to file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-add-shared-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | string | yes | Explicitly request the `shared_link` fields to be returned for this item. |
| body | object | no | JSON request body |

### Update shared link on file
`POST https://zieapi.vercel.app/v1/cloud:box/put-files-id-update-shared-link` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| file_id | string | yes | The unique identifier that represents a file. The ID for any file can be determined by visiting a file in the web application and copying… |
| fields | string | yes | Explicitly request the `shared_link` fields to be returned for this item. |
| body | object | no | JSON request body |

…and 175 more. See the OpenAPI spec.

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:box/get-authorize" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Box Platform API API?
Create a free Apizie key, then send GET https://zieapi.vercel.app/v1/cloud:box/get-authorize with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Box Platform API API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Box Platform API itself also needs your own key from box.

### Can AI agents use the Box Platform API API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:box.

### What is the status of the Box Platform API API?
Needs your own provider key (bring your own key)