Box Connector v1.0 Initial Release | OneTeg Documentation

Version 1

Connector Overview: This page documents all 266 endpoints for the Boxconnector v1.

GET

AI: Get AI agent default configuration

Get the AI agent default config

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Mode`	The mode to filter the agent config to return.
`Language`	The ISO language code to return the agent config for. If the language is not supported the default agent config is returned.
`Model`	The model to return the default agent config for.
`Response Type`	N/A

POST

AI: Send AI question request

Sends an AI request to supported LLMs and returns an answer specifically focused on the user's question given the provided context.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Mode`	The mode specifies if this request is for a single or multiple items. If you select single_item_qa the items array can have one element only. Selecting multiple_item_qa allows you to provide up to 25 items.
`Prompt`	The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.
`Include Citations`	A flag to indicate whether citations should be returned.

POST

AI: Send AI request to generate text

Sends an AI request to supported LLMs and returns an answer specifically focused on the creation of new text.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Prompt`	The prompt provided by the client to be answered by the LLM. The prompt's length is limited to 10000 characters.

GET

Authorization: Authorize user

Authorize a user by sending them through the Box
website and request their permission to act on their behalf.

This is the first step when authenticating a user using
OAuth 2.0. To request a user's authorization to use the Box APIs
on their behalf you will need to send a user to the URL with this
format.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	The type of response we'd like to receive.
`Client Id`	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 Box developer console and click the Edit Application link for the application you're working with. In the OAuth 2.0 Parameters section of the configuration page, find the item labelled client_id. The text of that item is your application's Client ID.
`Redirect Uri`	The URI to which Box redirects the browser after the user has granted or denied the application permission. This URI match one of the redirect URIs in the configuration of your application. It must be a valid HTTPS URI and it needs to be able to handle the redirection to complete the next step in the OAuth 2.0 flow. Although this parameter is optional, it must be a part of the authorization URL if you configured multiple redirect URIs for the application in the developer console. A missing parameter causes a redirect_uri_missing error after the user grants application access.
`State`	A custom string of your choice. Box will pass the same string to the redirect URL when authentication is complete. This parameter can be used to identify a user on redirect, as well as protect against hijacked sessions and other exploits.
`Scope`	A space-separated list of application scopes you'd like to authenticate the user for. This defaults to all the scopes configured for the application in its configuration page.
`Response Type`	N/A

POST

Authorization: Refresh access token

Refresh an Access Token using its client ID, secret, and refresh token.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Grant Type`	The type of request being made, in this case a refresh request.
`Client Id`	The client ID of the application requesting to refresh the token.
`Client Secret`	The client secret of the application requesting to refresh the token.
`Refresh Token`	The refresh token to refresh.

POST

Authorization: Request access token

Request an Access Token using either a client-side obtained OAuth 2.0
authorization code or a server-side JWT assertion.

An Access Token is a string that enables Box to verify that a
request belongs to an authorized session. In the normal order of
operations you will begin by requesting authentication from the
authorize endpoint and Box will send you an
authorization code.

You will then send this code to this endpoint to exchange it for
an Access Token. The returned Access Token can then be used to to make
Box API calls.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (15)

Option Name	Description
`Grant Type`	The type of request being made, either using a client-side obtained authorization code, a refresh token, a JWT assertion, client credentials grant or another access token for the purpose of downscoping a token.
`Client Id`	The Client ID of the application requesting an access token. Used in combination with authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
`Client Secret`	The client secret of the application requesting an access token. Used in combination with authorization_code, client_credentials, or urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
`Code`	The client-side authorization code passed to your application by Box in the browser redirect after the user has successfully granted your application permission to make API calls on their behalf. Used in combination with authorization_code as the grant_type.
`Refresh Token`	A refresh token used to get a new access token with. Used in combination with refresh_token as the grant_type.
`Assertion`	A JWT assertion for which to request a new access token. Used in combination with urn:ietf:params:oauth:grant-type:jwt-bearer as the grant_type.
`Subject Token`	The token to exchange for a downscoped token. This can be a regular access token, a JWT assertion, or an app token. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
`Subject Token Type`	The type of subject_token passed in. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
`Actor Token`	The token used to create an annotator token. This is a JWT assertion. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
`Actor Token Type`	The type of actor_token passed in. Used in combination with urn:ietf:params:oauth:grant-type:token-exchange as the grant_type.
`Scope`	The space-delimited list of scopes that you want apply to the new access token. The subject_token will need to have all of these scopes or the call will error with 401 Unauthorized.
`Resource`	Full URL for the file that the token should be generated for.
`Box Subject Type`	Used in combination with client_credentials as the grant_type.
`Box Subject Id`	Used in combination with client_credentials as the grant_type. Value is determined by box_subject_type. If user use user ID and if enterprise use enterprise ID.
`Box Shared Link`	Full URL of the shared link on the file or folder that the token should be generated for.

POST

Authorization: Revoke access token

Revoke an active Access Token, effectively logging a user out
that has been previously authenticated.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Client Id`	The Client ID of the application requesting to revoke the access token.
`Client Secret`	The client secret of the application requesting to revoke an access token.
`Token`	The access token to revoke.

POST

Classifications on files: Add classification to file

Adds a classification to a file by specifying the label of the
classification to add.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

Options (1)

Option Name	Description
`Box Security Classification Key`	The name of the classification to apply to this file. To list the available classifications in an enterprise, use the classification API to retrieve the classification template which lists all available classification keys.

Option Name

Description

Box Security Classification Key

The name of the classification to apply to this file.

To list the available classifications in an enterprise,
use the classification API to retrieve the
classification template
which lists all available classification keys.

GET

Classifications on files: Get classification on file

Retrieves the classification metadata instance that
has been applied to a file.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

DELETE

Classifications on files: Remove classification from file

Removes any classifications from a file.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/files/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

PUT

Classifications on files: Update classification on file

Updates a classification on a file.

The classification can only be updated if a classification has already been
applied to the file before. When editing classifications, only values are
defined for the enterprise will be accepted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

Options (3)

Option Name

Description

Op

replace

Path

Defines classifications
available in the enterprise.

Value

The name of the classification to apply to this file.

To list the available classifications in an enterprise,
use the classification API to retrieve the
classification template
which lists all available classification keys.

POST

Classifications on folders: Add classification to folder

Adds a classification to a folder by specifying the label of the
classification to add.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

Options (1)

Option Name	Description
`Box Security Classification Key`	The name of the classification to apply to this folder. To list the available classifications in an enterprise, use the classification API to retrieve the classification template which lists all available classification keys.

Option Name

Description

Box Security Classification Key

The name of the classification to apply to this folder.

To list the available classifications in an enterprise,
use the classification API to retrieve the
classification template
which lists all available classification keys.

GET

Classifications on folders: Get classification on folder

Retrieves the classification metadata instance that
has been applied to a folder.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

DELETE

Classifications on folders: Remove classification from folder

Removes any classifications from a folder.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/folders/:id//enterprise_12345/securityClassification-6VMVochwUWo.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

PUT

Classifications on folders: Update classification on folder

Updates a classification on a folder.

The classification can only be updated if a classification has already been
applied to the folder before. When editing classifications, only values are
defined for the enterprise will be accepted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

Options (3)

Option Name

Description

Op

replace

Path

Defines classifications
available in the enterprise.

Value

The name of the classification to apply to this folder.

To list the available classifications in an enterprise,
use the classification API to retrieve the
classification template
which lists all available classification keys.

PUT

Classifications: Add classification

Adds one or more new classifications to the list of classifications
available to the enterprise.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Op`	The type of change to perform on the classification object.
`Fieldkey`	Defines classifications available in the enterprise.

POST

Classifications: Add initial classifications

When an enterprise does not yet have any classifications, this API call
initializes the classification template with an initial set of
classifications.

If an enterprise already has a classification, the template will already
exist and instead an API call should be made to add additional
classifications.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Scope`	The scope in which to create the classifications. This should be enterprise or enterprise_{id} where id is the unique ID of the enterprise.
`Templatekey`	Defines the list of metadata templates.
`Displayname`	The name of the template as shown in web and mobile interfaces.
`Hidden`	Determines if the classification template is hidden or available on web and mobile devices.
`Copyinstanceonitemcopy`	Determines if classifications are copied along when the file or folder is copied.

GET

Classifications: List all classifications

Retrieves the classification metadata template and lists all the
classifications available to this enterprise.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

PUT

Classifications: Update classification

Updates the labels and descriptions of one or more classifications
available to the enterprise.

This API can also be called by including the enterprise ID in the
URL explicitly, for example
/metadata_templates/enterprise_12345/securityClassification-6VMVochwUWo/schema.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Op`	The type of change to perform on the classification object.
`Fieldkey`	Defines classifications available in the enterprise.
`Enumoptionkey`	The original label of the classification to change.

GET

Collaborations (List): List file collaborations

Retrieves a list of pending and active collaborations for a
file. This returns all the users that have access to the file
or have been invited to the file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Response Type`	N/A

GET

Collaborations (List): List folder collaborations

Retrieves a list of pending and active collaborations for a
folder. This returns all the users that have access to the folder
or have been invited to the folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Collaborations (List): List group collaborations

Retrieves all the collaborations for a group. The user
must have admin permissions to inspect enterprise's groups.

Each collaboration object has details on which files or
folders the group has access to and with what role.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Id`	The ID of the group.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

GET

Collaborations (List): List pending collaborations

Retrieves all pending collaboration invites for this user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Status`	The status of the collaborations to retrieve
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Collaborations: Create collaboration

Adds a collaboration for a single user or a single group to a file
or folder.

Collaborations can be created using email address, user IDs, or a
group IDs.

If a collaboration is being created with a group, access to
this endpoint is dependent on the group's ability to be invited.

If collaboration is in pending status, the following fields
are redacted:

login and name are hidden if a collaboration was created

using user_id,

name is hidden if a collaboration was created using login.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Notify`	Determines if users should receive email notification for the action performed.
`Response Type`	N/A

Options (4)

Option Name	Description
`Role`	The level of access granted.
`Is Access Only`	If set to true, collaborators have access to shared items, but such items won't be visible in the All Files list. Additionally, collaborators won't see the the path to the root folder for the shared item.
`Can View Path`	Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee's All Files page. We recommend you limit the number of collaborations with can_view_path enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a can_view_path of true. can_view_path can only be used for folder collaborations.
`Expires At`	Set the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the Automatically remove invited collaborators: Allow folder owners to extend the expiry date setting has been enabled in the Enterprise Settings of the Admin Console. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error.

GET

Collaborations: Get collaboration

Retrieves a single collaboration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Id`	The ID of the collaboration
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

DELETE

Collaborations: Remove collaboration

Deletes a single collaboration.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Id`	The ID of the collaboration
`Response Type`	N/A

PUT

Collaborations: Update collaboration

Updates a collaboration.
Can be used to change the owner of an item, or to
accept collaboration invites.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Id`	The ID of the collaboration
`Response Type`	N/A

Options (4)

Option Name	Description
`Role`	The level of access granted.
`Status`	Set the status of a pending collaboration invitation, effectively accepting, or rejecting the invite.
`Expires At`	Update the expiration date for the collaboration. At this date, the collaboration will be automatically removed from the item. This feature will only work if the Automatically remove invited collaborators: Allow folder owners to extend the expiry date setting has been enabled in the Enterprise Settings of the Admin Console. When the setting is not enabled, collaborations can not have an expiry date and a value for this field will be result in an error. Additionally, a collaboration can only be given an expiration if it was created after the Automatically remove invited collaborator setting was enabled.
`Can View Path`	Determines if the invited users can see the entire parent path to the associated folder. The user will not gain privileges in any parent folder and therefore can not see content the user is not collaborated on. Be aware that this meaningfully increases the time required to load the invitee's All Files page. We recommend you limit the number of collaborations with can_view_path enabled to 1,000 per user. Only owner or co-owners can invite collaborators with a can_view_path of true. can_view_path can only be used for folder collaborations.

GET

Collections: List all collections

Retrieves all collections for a given user.

Currently, only the favorites collection
is supported.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

GET

Collections: List collection items

Retrieves the files and/or folders contained within
this collection.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collection Id`	The ID of the collection.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Comments: Create comment

Adds a comment by the user to a specific file, or
as a reply to an other comment.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (2)

Option Name	Description
`Message`	The text of the comment. To mention a user, use the tagged_message parameter instead.
`Tagged Message`	The text of the comment, including @[user_id:name] somewhere in the message to mention another user, which will send them an email notification, letting them know they have been mentioned. The user_id is the target user's ID, where the name can be any custom phrase. In the Box UI this name will link to the user's profile. If you are not mentioning another user, use message instead.

Option Name

Description

Message

The text of the comment.

To mention a user, use the tagged_message
parameter instead.

Tagged Message

The text of the comment, including @[user_id:name]
somewhere in the message to mention another user, which
will send them an email notification, letting them know
they have been mentioned.

The user_id is the target user's ID, where the name
can be any custom phrase. In the Box UI this name will
link to the user's profile.

If you are not mentioning another user, use message
instead.

GET

Comments: Get comment

Retrieves the message and metadata for a specific comment, as well
as information on the user who created the comment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	The ID of the comment.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Comments: List file comments

Retrieves a list of comments for a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

DELETE

Comments: Remove comment

Permanently deletes a comment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	The ID of the comment.
`Response Type`	N/A

PUT

Comments: Update comment

Update the message of a comment.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Comment Id`	The ID of the comment.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name	Description
`Message`	The text of the comment to update

GET

Device pinners: Get device pin

Retrieves information about an individual device pin.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Device Pinner Id`	The ID of the device pin
`Response Type`	N/A

GET

Device pinners: List enterprise device pins

Retrieves all the device pins within an enterprise.

The user must have admin privileges, and the application
needs the "manage enterprise" scope to make this call.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Enterprise Id`	The ID of the enterprise
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Direction`	The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
`Response Type`	N/A

DELETE

Device pinners: Remove device pin

Deletes an individual device pin.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Device Pinner Id`	The ID of the device pin
`Response Type`	N/A

POST

Domain restrictions (User exemptions): Create user exemption from collaboration domain restrictions

Exempts a user from the restrictions set out by the allowed list of domains
for collaborations.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET

Domain restrictions (User exemptions): Get user exempt from collaboration domain restrictions

Returns a users who has been exempt from the collaboration
domain restrictions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Whitelist Exempt Target Id`	The ID of the exemption to the list.
`Response Type`	N/A

GET

Domain restrictions (User exemptions): List users exempt from collaboration domain restrictions

Returns a list of users who have been exempt from the collaboration
domain restrictions.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Domain restrictions (User exemptions): Remove user from list of users exempt from domain restrictions

Removes a user's exemption from the restrictions set out by the allowed list
of domains for collaborations.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Whitelist Exempt Target Id`	The ID of the exemption to the list.
`Response Type`	N/A

POST

Domain restrictions for collaborations: Add domain to list of allowed collaboration domains

Creates a new entry in the list of allowed domains to allow
collaboration for.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Domain`	The domain to add to the list of allowed domains.
`Direction`	The direction in which to allow collaborations.

GET

Domain restrictions for collaborations: Get allowed collaboration domain

Returns a domain that has been deemed safe to create collaborations
for within the current enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Whitelist Entry Id`	The ID of the entry in the list.
`Response Type`	N/A

GET

Domain restrictions for collaborations: List allowed collaboration domains

Returns the list domains that have been deemed safe to create collaborations
for within the current enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Domain restrictions for collaborations: Remove domain from list of allowed collaboration domains

Removes a domain from the list of domains that have been deemed safe to create
collaborations for within the current enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Collaboration Whitelist Entry Id`	The ID of the entry in the list.
`Response Type`	N/A

GET

Downloads: Download file

Returns the contents of a file in binary format.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Range`	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 download.
`Boxapi`	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 shared with a user. Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password]. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.
`Version`	The file version to download
`Access Token`	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 or a third party service without them needing to know how to handle the authentication. When using this parameter, please make sure that the access token is sufficiently scoped down to only allow read access to that file and no other files or folders.
`Response Type`	N/A

POST

Email aliases: Create email alias

Adds a new email alias to a user account..

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Response Type`	N/A

Options (1)

Option Name

Description

Email

The email address to add to the account as an alias.

Note: The domain of the email alias needs to be registered
to your enterprise.
See the domain verification guide for steps to add a new domain.

GET

Email aliases: List user's email aliases

Retrieves all email aliases for a user. The collection
does not include the primary login for the user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Response Type`	N/A

DELETE

Email aliases: Remove email alias

Removes an email alias from a user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Email Alias Id`	The ID of the email alias.
`Response Type`	N/A

UNKNOWN

Events: Get events long poll endpoint (OPTIONS)

Returns a list of real-time servers that can be used for long-polling updates
to the event stream.

Long polling is the concept where a HTTP request is kept open until the
server sends a response, then repeating the process over and over to receive
updated responses.

Long polling the event stream can only be used for user events, not for
enterprise events.

To use long polling, first use this endpoint to retrieve a list of long poll
URLs. Next, make a long poll request to any of the provided URLs.

When an event occurs in monitored account a response with the value
new_changewill be sent. The response contains no other details as
it only serves as a prompt to take further action such as sending a
request to the events endpoint with the last known
stream_position.

After the server sends this response it closes the connection. You must now
repeat the long poll process to begin listening for events again.

If no events occur for a while and the connection times out you will
receive a response with the value reconnect. When you receive this response
you’ll make another call to this endpoint to restart the process.

If you receive no events in retry_timeout seconds then you will need to
make another request to the real-time server (one of the URLs in the response
for this endpoint). This might be necessary due to network errors.

Finally, if you receive a max_retries error when making a request to the
real-time server, you should start over by making a call to this endpoint
first.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET

Events: List user and enterprise events

Returns up to a year of past events for a given user
or for the entire enterprise.

By default this returns events for the authenticated user. To retrieve events
for the entire enterprise, set the stream_type to admin_logs_streaming
for live monitoring of new events, or admin_logs for querying across
historical events. The user making the API call will
need to have admin privileges, and the application will need to have the
scope manage enterprise properties checked.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Stream Type`	Defines the type of events that are returned all returns everything for a user and is the default changes returns events that may cause file tree changes such as file updates or collaborations. sync is similar to changes but only applies to synced folders admin_logs returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for programmatically pulling from a 1 year history of events across all users within the enterprise and within a created_after and created_before time frame. The complete history of events will be returned in chronological order based on the event time, but latency will be much higher than admin_logs_streaming. admin_logs_streaming returns all events for an entire enterprise and requires the user making the API call to have admin permissions. This stream type is for polling for recent events across all users within the enterprise. Latency will be much lower than admin_logs, but events will not be returned in chronological order and may contain duplicates.
`Stream Position`	The location in the event stream to start receiving events from. now will return an empty list events and the latest stream position for initialization. 0 or null will return all events.
`Limit`	Limits the number of events returned Note: Sometimes, the events less than the limit requested can be returned even when there may be more events remaining. This is primarily done in the case where a number of events have already been retrieved and these retrieved events are returned rather than delaying for an unknown amount of time to see if there are any more results.
`Event Type`	A comma-separated list of events to filter by. This can only be used when requesting the events with a stream_type of admin_logs or adming_logs_streaming. For any other stream_type this value will be ignored.
`Created After`	The lower bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.
`Created Before`	The upper bound date and time to return events for. This can only be used when requesting the events with a stream_type of admin_logs. For any other stream_type this value will be ignored.
`Response Type`	N/A

POST

File requests: Copy file request

Copies an existing file request that is already present on one folder,
and applies it to another folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Request Id`	The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.
`Response Type`	N/A

Options (6)

Option Name	Description
`Title`	An optional new title for the file request. This can be used to change the title of the file request. This will default to the value on the existing file request.
`Description`	An optional new description for the file request. This can be used to change the description of the file request. This will default to the value on the existing file request.
`Status`	An optional new status of the file request. When the status is set to inactive, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a HTTP 404 status code. This will default to the value on the existing file request.
`Is Email Required`	Whether a file request submitter is required to provide their email address. When this setting is set to true, the Box UI will show an email field on the file request form. This will default to the value on the existing file request.
`Is Description Required`	Whether a file request submitter is required to provide a description of the files they are submitting. When this setting is set to true, the Box UI will show a description field on the file request form. This will default to the value on the existing file request.
`Expires At`	The date after which a file request will no longer accept new submissions. After this date, the status will automatically be set to inactive. This will default to the value on the existing file request.

DELETE

File requests: Delete file request

Deletes a file request permanently.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Request Id`	The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.
`Response Type`	N/A

GET

File requests: Get file request

Retrieves the information about a file request.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Request Id`	The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.
`Response Type`	N/A

PUT

File requests: Update file request

Updates a file request. This can be used to activate or
deactivate a file request.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Request Id`	The unique identifier that represent a file request. The ID for any file request can be determined by visiting a file request builder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/filerequest/123 the file_request_id is 123.
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Response Type`	N/A

Options (6)

Option Name	Description
`Title`	An optional new title for the file request. This can be used to change the title of the file request. This will default to the value on the existing file request.
`Description`	An optional new description for the file request. This can be used to change the description of the file request. This will default to the value on the existing file request.
`Status`	An optional new status of the file request. When the status is set to inactive, the file request will no longer accept new submissions, and any visitor to the file request URL will receive a HTTP 404 status code. This will default to the value on the existing file request.
`Is Email Required`	Whether a file request submitter is required to provide their email address. When this setting is set to true, the Box UI will show an email field on the file request form. This will default to the value on the existing file request.
`Is Description Required`	Whether a file request submitter is required to provide a description of the files they are submitting. When this setting is set to true, the Box UI will show a description field on the file request form. This will default to the value on the existing file request.
`Expires At`	The date after which a file request will no longer accept new submissions. After this date, the status will automatically be set to inactive. This will default to the value on the existing file request.

GET

File version legal holds: Get file version legal hold

Retrieves information about the legal hold policies
assigned to a file version.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Version Legal Hold Id`	The ID of the file version legal hold
`Response Type`	N/A

GET

File version legal holds: List file version legal holds

Get a list of file versions on legal hold for a legal hold
assignment.

Due to ongoing re-architecture efforts this API might not return all file
versions for this policy ID.

Instead, this API will only return file versions held in the legacy
architecture. Two new endpoints will available to request any file versions
held in the new architecture.

For file versions held in the new architecture, the `GET
/legal_hold_policy_assignments/:id/file_versions_on_hold` API can be used to
return all past file versions available for this policy assignment, and the
GET /legal_hold_policy_assignments/:id/files_on_holdAPI can be used to
return any current (latest) versions of a file under legal hold.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to
find a list of policy assignments for a given policy ID.

Once the re-architecture is completed this API will be deprecated.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Policy Id`	The ID of the legal hold policy to get the file version legal holds for.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

GET

File version retentions: Get retention on file

Returns information about a file version retention.

Note:
File retention API is now deprecated.
To get information about files and file versions under retention,
see files under retention or file versions under retention endpoints.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Version Retention Id`	The ID of the file version retention
`Response Type`	N/A

GET

File version retentions: List file version retentions

Retrieves all file version retentions for the given enterprise.

Note:
File retention API is now deprecated.
To get information about files and file versions under retention,
see files under retention or file versions under retention endpoints.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	Filters results by files with this ID.
`File Version Id`	Filters results by file versions with this ID.
`Policy Id`	Filters results by the retention policy with this ID.
`Disposition Action`	Filters results by the retention policy with this disposition action.
`Disposition Before`	Filters results by files that will have their disposition come into effect before this date.
`Disposition After`	Filters results by files that will have their disposition come into effect after this date.
`Limit`	The maximum number of items to return per page.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Response Type`	N/A

GET

File versions: Get file version

Retrieve a specific version of a file.

Versions are only tracked for Box users with premium accounts.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`File Version Id`	The ID of the file version
`Response Type`	N/A

GET

File versions: List all file versions

Retrieve a list of the past versions for a file.

Versions are only tracked by Box users with premium accounts. To fetch the ID
of the current version of a file, use the GET /file/:id API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

POST

File versions: Promote file version

Promote a specific version of a file.

If previous versions exist, this method can be used to
promote one of the older versions to the top of the version history.

This creates a new copy of the old version and puts it at the
top of the versions history. The file will have the exact same contents
as the older version, with the the same hash digest, etag, and
name as the original.

Other properties such as comments do not get updated to their
former values.

Don't use this endpoint to restore Box Notes,
as it works with file formats such as PDF, DOC,
PPTX or similar.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The file version ID
`Type`	The type to promote

DELETE

File versions: Remove file version

Move a file version to the trash.

Versions are only tracked for Box users with premium accounts.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`File Version Id`	The ID of the file version
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Response Type`	N/A

PUT

File versions: Restore file version

Restores a specific version of a file after it was deleted.
Don't use this endpoint to restore Box Notes,
as it works with file formats such as PDF, DOC,
PPTX or similar.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`File Version Id`	The ID of the file version
`Response Type`	N/A

Options (1)

Option Name	Description
`Trashed At`	Set this to null to clear the date and restore the file.

POST

Files: Copy file

Creates a copy of a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (2)

Option Name

Description

Name

An optional new name for the copied file.

There are some restrictions to the file name. Names containing
non-printable ASCII characters, forward and backward slashes
(/, \), and protected names like . and .. are
automatically sanitized by removing the non-allowed
characters.

Version

An optional ID of the specific file version to copy.

DELETE

Files: Delete file

Deletes a file, either permanently or by moving it to
the trash.

The the enterprise settings determine whether the item will
be permanently deleted from Box or moved to the trash.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Response Type`	N/A

GET

Files: Get file information

Retrieves the details about a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.
`If-none-match`	Ensures an item is only returned if it has changed. Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.
`Boxapi`	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 shared with a user. Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password]. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.
`X-rep-hints`	A header required to request specific representations of a file. Use this in combination with the fields query parameter to request a specific file representation. The general format for these representations is X-Rep-Hints: [...] where [...] is one or many hints in the format [fileType?query]. For example, to request a png representation in 32x32 as well as 64x64 pixel dimensions provide the following hints. x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64] Additionally, a text representation is available for all document file types in Box using the [extracted_text] representation. x-rep-hints: [extracted_text]
`Response Type`	N/A

GET

Files: Get file thumbnail

Retrieves a thumbnail, or smaller image representation, of a file.

Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in
the .png format and sizes of 32x32, 160x160, and 320x320
can be returned in the .jpg format.

Thumbnails can be generated for the image and video file formats listed
[found on our community site][1].

[1]: https://community.box.com/t5/Migrating-and-Previewing-Content/File-Types-and-Fonts-Supported-in-Box-Content-Preview/ta-p/327

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Extension`	The file format for the thumbnail
`Min Height`	The minimum height of the thumbnail
`Min Width`	The minimum width of the thumbnail
`Max Height`	The maximum height of the thumbnail
`Max Width`	The maximum width of the thumbnail
`Response Type`	N/A

UNKNOWN

Files: Preflight check before upload (OPTIONS)

Performs a check to verify that a file will be accepted by Box
before you upload the entire file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	The name for the file
`Size`	The size of the file in bytes

PUT

Files: Update file

Updates a file. This can be used to rename or move a file,
create a shared link, or lock a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Response Type`	N/A

Options (4)

Option Name	Description
`Name`	An optional different name for the file. This can be used to rename the file.
`Description`	The description for a file. This can be seen in the right-hand sidebar panel when viewing a file in the Box web app. Additionally, this index is used in the search index of the file, allowing users to find the file by the content in the description.
`Disposition At`	The retention expiration timestamp for the given file. This date cannot be shortened once set on a file.
`Tags`	The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item's current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.

POST

Folder Locks: Create folder lock

Creates a folder lock on a folder, preventing it from being moved and/or
deleted.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

DELETE

Folder Locks: Delete folder lock

Deletes a folder lock on a given folder.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Lock Id`	The ID of the folder lock.
`Response Type`	N/A

GET

Folder Locks: List folder locks

Retrieves folder lock details for a given folder.

You must be authenticated as the owner or co-owner of the folder to
use this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

POST

Folders: Copy folder

Creates a copy of a folder within a destination folder.

The original folder will not be changed.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	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 copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder with the ID 0 can not be copied.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name

Description

Name

An optional new name for the copied folder.

There are some restrictions to the file name. Names containing
non-printable ASCII characters, forward and backward slashes
(/, \), as well as names with trailing spaces are
prohibited.

Additionally, the names . and .. are
not allowed either.

POST

Folders: Create folder

Creates a new empty folder within the specified parent folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (2)

Option Name

Description

Name

The name for the new folder.

There are some restrictions to the file name. Names containing
non-printable ASCII characters, forward and backward slashes
(/, \), as well as names with trailing spaces are
prohibited.

Additionally, the names . and .. are
not allowed either.

Sync State

Specifies whether a folder should be synced to a
user's device or not. This is used by Box Sync
(discontinued) and is not used by Box Drive.

DELETE

Folders: Delete folder

Deletes a folder, either permanently or by moving it to
the trash.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Recursive`	Delete a folder that is not empty by recursively deleting the folder and all of its content.
`Response Type`	N/A

GET

Folders: Get folder information

Retrieves details for a folder, including the first 100 entries
in the folder.

Passing sort, direction, offset, and limit
parameters in query allows you to manage the
list of returned
folder items.

To fetch more items within the folder, use the
Get items in a folder endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.
`If-none-match`	Ensures an item is only returned if it has changed. Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.
`Boxapi`	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 shared with a user. Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password]. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.
`Sort`	Defines the second attribute by which items are sorted. The folder type affects the way the items are sorted: Standard folder: Items are always sorted by their type first, with folders listed before files, and files listed before web links. Root folder: This parameter is not supported for marker-based pagination on the root folder (the folder with an id of 0). Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.
`Direction`	The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

GET

Folders: List items in folder

Retrieves a page of items in a folder. These items can be files,
folders, and web links.

To request more information about the folder itself, like its size,
use the Get a folder endpoint instead.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested. Additionally this field can be used to query any metadata applied to the file by specifying the metadata field as well as the scope and key of the template to retrieve, for example ?fields=metadata.enterprise_12345.contractTemplate.
`Usemarker`	Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Boxapi`	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 shared with a user. Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password]. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.
`Sort`	Defines the second attribute by which items are sorted. The folder type affects the way the items are sorted: Standard folder: Items are always sorted by their type first, with folders listed before files, and files listed before web links. Root folder: This parameter is not supported for marker-based pagination on the root folder (the folder with an id of 0). Shared folder with parent path to the associated folder visible to the collaborator: Items are always sorted by their type first, with folders listed before files, and files listed before web links.
`Direction`	The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
`Response Type`	N/A

PUT

Folders: Update folder

Updates a folder. This can be also be used to move the folder,
create shared links, update collaborations, and more.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Response Type`	N/A

Options (7)

Option Name	Description
`Name`	The optional new name for this folder.
`Description`	The optional description of this folder
`Sync State`	Specifies whether a folder should be synced to a user's device or not. This is used by Box Sync (discontinued) and is not used by Box Drive.
`Can Non Owners Invite`	Specifies if users who are not the owner of the folder can invite new collaborators to the folder.
`Tags`	The tags for this item. These tags are shown in the Box web app and mobile apps next to an item. To add or remove a tag, retrieve the item's current tags, modify them, and then update this field. There is a limit of 100 tags per item, and 10,000 unique tags per enterprise.
`Is Collaboration Restricted To Enterprise`	Specifies if new invites to this folder are restricted to users within the enterprise. This does not affect existing collaborations.
`Can Non Owners View Collaborators`	Restricts collaborators who are not the owner of this folder from viewing other collaborations on this folder. It also restricts non-owners from inviting new collaborators. When setting this field to false, it is required to also set can_non_owners_invite_collaborators to false if it has not already been set.

POST

Group memberships: Add user to group

Creates a group membership. Only users with
admin-level permissions will be able to use this API.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name	Description
`Role`	The role of the user in the group.

GET

Group memberships: Get group membership

Retrieves a specific group membership. Only admins of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Membership Id`	The ID of the group membership.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Group memberships: List members of group

Retrieves all the members for a group. Only members of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Id`	The ID of the group.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

GET

Group memberships: List user's groups

Retrieves all the groups for a user. Only members of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

DELETE

Group memberships: Remove user from group

Deletes a specific group membership. Only admins of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Membership Id`	The ID of the group membership.
`Response Type`	N/A

PUT

Group memberships: Update group membership

Updates a user's group membership. Only admins of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Membership Id`	The ID of the group membership.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name	Description
`Role`	The role of the user in the group.

POST

Groups: Create group

Creates a new group of users in an enterprise. Only users with admin
permissions can create new groups.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	The name of the new group to be created. This name must be unique within the enterprise.
`Provenance`	Keeps track of which external source this group is coming, for example Active Directory, or Okta. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
`External Sync Identifier`	An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
`Description`	A human readable description of the group.
`Invitability Level`	Specifies who can invite the group to collaborate on folders. When set to admins_only the enterprise admin, co-admins, and the group's admin can invite the group. When set to admins_and_members all the admins listed above and group members can invite the group. When set to all_managed_users all managed users in the enterprise can invite the group.
`Member Viewability Level`	Specifies who can see the members of the group. admins_only - the enterprise admin, co-admins, group's group admin admins_and_members - all admins and group members all_managed_users - all managed users in the enterprise

GET

Groups: Get group

Retrieves information about a group. Only members of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Id`	The ID of the group.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Groups: List groups for enterprise

Retrieves all of the groups for a given enterprise. The user
must have admin permissions to inspect enterprise's groups.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter Term`	Limits the results to only groups whose name starts with the search term.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

DELETE

Groups: Remove group

Permanently deletes a group. Only users with
admin-level permissions will be able to use this API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Id`	The ID of the group.
`Response Type`	N/A

PUT

Groups: Update group

Updates a specific group. Only admins of this
group or users with admin-level permissions will be able to
use this API.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Group Id`	The ID of the group.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (6)

Option Name	Description
`Name`	The name of the new group to be created. Must be unique within the enterprise.
`Provenance`	Keeps track of which external source this group is coming, for example Active Directory, or Okta. Setting this will also prevent Box admins from editing the group name and its members directly via the Box web application. This is desirable for one-way syncing of groups.
`External Sync Identifier`	An arbitrary identifier that can be used by external group sync tools to link this Box Group to an external group. Example values of this field could be an Active Directory Object ID or a Google Group ID. We recommend you use of this field in order to avoid issues when group names are updated in either Box or external systems.
`Description`	A human readable description of the group.
`Invitability Level`	Specifies who can invite the group to collaborate on folders. When set to admins_only the enterprise admin, co-admins, and the group's admin can invite the group. When set to admins_and_members all the admins listed above and group members can invite the group. When set to all_managed_users all managed users in the enterprise can invite the group.
`Member Viewability Level`	Specifies who can see the members of the group. admins_only - the enterprise admin, co-admins, group's group admin admins_and_members - all admins and group members all_managed_users - all managed users in the enterprise

POST

Integration mappings: Create Slack integration mapping

Creates a Slack integration mapping
by mapping a Slack channel to a Box item.

You need Admin or Co-Admin role to
use this endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

DELETE

Integration mappings: Delete Slack integration mapping

Deletes a Slack integration mapping.

You need Admin or Co-Admin role to
use this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Integration Mapping Id`	An ID of an integration mapping
`Response Type`	N/A

GET

Integration mappings: List Slack integration mappings

Lists Slack integration mappings in a users' enterprise.

You need Admin or Co-Admin role to
use this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Partner Item Type`	Mapped item type, for which the mapping should be returned
`Partner Item Id`	ID of the mapped item, for which the mapping should be returned
`Box Item Id`	Box item ID, for which the mappings should be returned
`Box Item Type`	Box item type, for which the mappings should be returned
`Is Manually Created`	Whether the mapping has been manually created
`Response Type`	N/A

PUT

Integration mappings: Update Slack integration mapping

Updates a Slack integration mapping.
Supports updating the Box folder ID and options.

You need Admin or Co-Admin role to
use this endpoint.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Integration Mapping Id`	An ID of an integration mapping
`Response Type`	N/A

POST

Invites: Create user invite

Invites an existing external user to join an enterprise.

The existing user can not be part of another enterprise and
must already have a Box account. Once invited, the user will receive an
email and are prompted to accept the invitation within the
Box web application.

This method requires the "Manage An Enterprise" scope enabled for
the application, which can be enabled within the developer console.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Invites: Get user invite status

Returns the status of a user invite.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Invite Id`	The ID of an invite.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

POST

Legal hold policies: Create legal hold policy

Create a new legal hold policy.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Policy Name`	The name of the policy.
`Description`	A description for the policy.
`Filter Started At`	The filter start date. When this policy is applied using a custodian legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter. Required if is_ongoing is set to false.
`Filter Ended At`	The filter end date. When this policy is applied using a custodian legal hold assignments, it will only apply to file versions created or uploaded inside of the date range. Other assignment types, such as folders and files, will ignore the date filter. Required if is_ongoing is set to false.
`Is Ongoing`	Whether new assignments under this policy should continue applying to files even after initialization. When this policy is applied using a legal hold assignment, it will continue applying the policy to any new file versions even after it has been applied. For example, if a legal hold assignment is placed on a user today, and that user uploads a file tomorrow, that file will get held. This will continue until the policy is retired. Required if no filter dates are set.

GET

Legal hold policies: Get legal hold policy

Retrieve a legal hold policy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Id`	The ID of the legal hold policy
`Response Type`	N/A

GET

Legal hold policies: List all legal hold policies

Retrieves a list of legal hold policies that belong to
an enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Policy Name`	Limits results to policies for which the names start with this search term. This is a case-insensitive prefix.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Legal hold policies: Remove legal hold policy

Delete an existing legal hold policy.

This is an asynchronous process. The policy will not be
fully deleted yet when the response returns.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Id`	The ID of the legal hold policy
`Response Type`	N/A

PUT

Legal hold policies: Update legal hold policy

Update legal hold policy.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Id`	The ID of the legal hold policy
`Response Type`	N/A

Options (3)

Option Name	Description
`Policy Name`	The name of the policy.
`Description`	A description for the policy.
`Release Notes`	Notes around why the policy was released.

POST

Legal hold policy assignments: Assign legal hold policy

Assign a legal hold to a file, file version, folder, or user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Policy Id`	The ID of the policy to assign.

GET

Legal hold policy assignments: Get legal hold policy assignment

Retrieve a legal hold policy assignment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Assignment Id`	The ID of the legal hold policy assignment
`Response Type`	N/A

GET

Legal hold policy assignments: List files with current file versions for legal hold policy assignment

Get a list of files with current file versions for a legal hold
assignment.

In some cases you may want to get previous file versions instead. In these
cases, use the GET /legal_hold_policy_assignments/:id/file_versions_on_hold
API instead to return any previous versions of a file for this legal hold
policy assignment.

Due to ongoing re-architecture efforts this API might not return all file
versions held for this policy ID. Instead, this API will only return the
latest file version held in the newly developed architecture. The `GET
/file_version_legal_holds` API can be used to fetch current and past versions
of files held within the legacy architecture.

This endpoint does not support returning any content that is on hold due to
a Custodian collaborating on a Hub.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to
find a list of policy assignments for a given policy ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Assignment Id`	The ID of the legal hold policy assignment
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Legal hold policy assignments: List legal hold policy assignments

Retrieves a list of items a legal hold policy has been assigned to.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Policy Id`	The ID of the legal hold policy
`Assign To Type`	Filters the results by the type of item the policy was applied to.
`Assign To Id`	Filters the results by the ID of item the policy was applied to.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Legal hold policy assignments: List previous file versions for legal hold policy assignment

Get a list of previous file versions for a legal hold
assignment.

In some cases you may only need the latest file versions instead. In these
cases, use the GET /legal_hold_policy_assignments/:id/files_on_hold API
instead to return any current (latest) versions of a file for this legal hold
policy assignment.

Due to ongoing re-architecture efforts this API might not return all files
held for this policy ID. Instead, this API will only return past file versions
held in the newly developed architecture. The GET /file_version_legal_holds
API can be used to fetch current and past versions of files held within the
legacy architecture.

This endpoint does not support returning any content that is on hold due to
a Custodian collaborating on a Hub.

The GET /legal_hold_policy_assignments?policy_id={id} API can be used to
find a list of policy assignments for a given policy ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Assignment Id`	The ID of the legal hold policy assignment
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

DELETE

Legal hold policy assignments: Unassign legal hold policy

Remove a legal hold from an item.

This is an asynchronous process. The policy will not be
fully removed yet when the response returns.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Legal Hold Policy Assignment Id`	The ID of the legal hold policy assignment
`Response Type`	N/A

POST

Metadata cascade policies: Create metadata cascade policy

Creates a new metadata cascade policy that applies a given
metadata template to a given folder and automatically
cascades it down to any files within that folder.

In order for the policy to be applied a metadata instance must first
be applied to the folder the policy is to be applied to.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name

Description

Folder Id

The ID of the folder to apply the policy to. This folder will
need to already have an instance of the targeted metadata
template applied to it.

Scope

The scope of the targeted metadata template. This template will
need to already have an instance applied to the targeted folder.

Templatekey

The key of the targeted metadata template. This template will
need to already have an instance applied to the targeted folder.

In many cases the template key is automatically derived
of its display name, for example Contract Template would
become contractTemplate. In some cases the creator of the
template will have provided its own template key.

Please [list the templates for an enterprise][list], or
get all instances on a [file][file] or [folder][folder]
to inspect a template's key.

[list]: e://get-metadata-templates-enterprise
[file]: e://get-files-id-metadata
[folder]: e://get-folders-id-metadata

POST

Metadata cascade policies: Force-apply metadata cascade policy to folder

Force the metadata on a folder with a metadata cascade policy to be applied to
all of its children. This can be used after creating a new cascade policy to
enforce the metadata to be cascaded down to all existing files within that
folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Metadata Cascade Policy Id`	The ID of the cascade policy to force-apply.
`Response Type`	N/A

Options (1)

Option Name

Description

Conflict Resolution

Describes the desired behavior when dealing with the conflict
where a metadata template already has an instance applied
to a child.

none will preserve the existing value on the file
overwrite will force-apply the templates values over
any existing values.

GET

Metadata cascade policies: Get metadata cascade policy

Retrieve a specific metadata cascade policy assigned to a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Metadata Cascade Policy Id`	The ID of the metadata cascade policy.
`Response Type`	N/A

GET

Metadata cascade policies: List metadata cascade policies

Retrieves a list of all the metadata cascade policies
that are applied to a given folder. This can not be used on the root
folder with ID 0.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	Specifies which folder to return policies for. This can not be used on the root folder with ID 0.
`Owner Enterprise Id`	The ID of the enterprise ID for which to find metadata cascade policies. If not specified, it defaults to the current enterprise.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Response Type`	N/A

DELETE

Metadata cascade policies: Remove metadata cascade policy

Deletes a metadata cascade policy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Metadata Cascade Policy Id`	The ID of the metadata cascade policy.
`Response Type`	N/A

POST

Metadata instances (Files): Create metadata instance on file

Applies an instance of a metadata template to a file.

In most cases only values that are present in the metadata template
will be accepted, except for the global.properties template which accepts
any key-value pair.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

GET

Metadata instances (Files): Get metadata instance on file

Retrieves the instance of a metadata template that has been applied to a
file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

GET

Metadata instances (Files): List metadata instances on file

Retrieves all metadata for a given file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

DELETE

Metadata instances (Files): Remove metadata instance from file

Deletes a piece of file metadata.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

PUT

Metadata instances (Files): Update metadata instance on file

Updates a piece of metadata on a file.

The metadata instance can only be updated if the template has already been
applied to the file before. When editing metadata, only values that match
the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the
application of the operations, the metadata instance will not be changed.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

Options (4)

Option Name	Description
`Op`	The type of change to perform on the template. Some of these are hazardous as they will change existing templates.
`Path`	The location in the metadata JSON object to apply the changes to, in the format of a JSON-Pointer. The path must always be prefixed with a / to represent the root of the template. The characters ~ and / are reserved characters and must be escaped in the key.
`Value`	The value to be set or tested. Required for add, replace, and test operations. For add, if the value exists already the previous value will be overwritten by the new value. For replace, the value must exist before replacing. For test, the existing value at the path location must match the specified value.
`From`	The location in the metadata JSON object to move or copy a value from. Required for move or copy operations and must be in the format of a JSON-Pointer.

POST

Metadata instances (Folders): Create metadata instance on folder

Applies an instance of a metadata template to a folder.

In most cases only values that are present in the metadata template
will be accepted, except for the global.properties template which accepts
any key-value pair.

To display the metadata template in the Box web app the enterprise needs to be
configured to enable Cascading Folder Level Metadata for the user in the
admin console.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

GET

Metadata instances (Folders): Get metadata instance on folder

Retrieves the instance of a metadata template that has been applied to a
folder. This can not be used on the root folder with ID 0.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

GET

Metadata instances (Folders): List metadata instances on folder

Retrieves all metadata for a given folder. This can not be used on the root
folder with ID 0.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

DELETE

Metadata instances (Folders): Remove metadata instance from folder

Deletes a piece of folder metadata.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

PUT

Metadata instances (Folders): Update metadata instance on folder

Updates a piece of metadata on a folder.

The metadata instance can only be updated if the template has already been
applied to the folder before. When editing metadata, only values that match
the metadata template schema will be accepted.

The update is applied atomically. If any errors occur during the
application of the operations, the metadata instance will not be changed.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

Options (4)

Option Name	Description
`Op`	The type of change to perform on the template. Some of these are hazardous as they will change existing templates.
`Path`	The location in the metadata JSON object to apply the changes to, in the format of a JSON-Pointer. The path must always be prefixed with a / to represent the root of the template. The characters ~ and / are reserved characters and must be escaped in the key.
`Value`	The value to be set or tested. Required for add, replace, and test operations. For add, if the value exists already the previous value will be overwritten by the new value. For replace, the value must exist before replacing. For test, the existing value at the path location must match the specified value.
`From`	The location in the metadata JSON object to move or copy a value from. Required for move or copy operations and must be in the format of a JSON-Pointer.

POST

Metadata templates: Create metadata template

Creates a new metadata template that can be applied to
files and folders.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (5)

Option Name	Description
`Scope`	The scope of the metadata template to create. Applications can only create templates for use within the authenticated user's enterprise. This value needs to be set to enterprise, as global scopes can not be created by applications.
`Templatekey`	A unique identifier for the template. This identifier needs to be unique across the enterprise for which the metadata template is being created. When not provided, the API will create a unique templateKey based on the value of the displayName.
`Displayname`	The display name of the template.
`Hidden`	Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API.
`Copyinstanceonitemcopy`	Whether or not to copy any metadata attached to a file or folder when it is copied. By default, metadata is not copied along with a file or folder when it is copied.

GET

Metadata templates: Find metadata template by instance ID

Finds a metadata template by searching for the ID of an instance of the
template.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Metadata Instance Id`	The ID of an instance of the metadata template to find.
`Response Type`	N/A

GET

Metadata templates: Get metadata template by ID

Retrieves a metadata template by its ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Template Id`	The ID of the template
`Response Type`	N/A

GET

Metadata templates: Get metadata template by name

Retrieves a metadata template by its scope and templateKey values.

To find the scope and templateKey for a template, list all templates for
an enterprise or globally, or list all templates applied to a file or folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

GET

Metadata templates: List all global metadata templates

Used to retrieve all generic, global metadata templates available to all
enterprises using Box.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

GET

Metadata templates: List all metadata templates for enterprise

Used to retrieve all metadata templates created to be used specifically within
the user's enterprise

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Metadata templates: Remove metadata template

Delete a metadata template and its instances.
This deletion is permanent and can not be reversed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

PUT

Metadata templates: Update metadata template

Updates a metadata template.

The metadata template can only be updated if the template
already exists.

The update is applied atomically. If any errors occur during the
application of the operations, the metadata template will not be changed.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Scope`	The scope of the metadata template
`Template Key`	The name of the metadata template
`Response Type`	N/A

Options (7)

Option Name	Description
`Op`	The type of change to perform on the template. Some of these are hazardous as they will change existing templates.
`Fieldkey`	For operations that affect a single field this defines the key of the field that is affected.
`Fieldkeys`	For operations that affect multiple fields this defines the keys of the fields that are affected.
`Enumoptionkey`	For operations that affect a single enum option this defines the key of the option that is affected.
`Enumoptionkeys`	For operations that affect multiple enum options this defines the keys of the options that are affected.
`Multiselectoptionkey`	For operations that affect a single multi select option this defines the key of the option that is affected.
`Multiselectoptionkeys`	For operations that affect multiple multi select options this defines the keys of the options that are affected.

GET

Recent items: List recently accessed items

Returns information about the recent items accessed
by a user, either in the last 90 days or up to the last
1000 items accessed.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Response Type`	N/A

POST

Retention policies: Create retention policy

Creates a retention policy.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (7)

Option Name	Description
`Policy Name`	The name for the retention policy
`Description`	The additional text description of the retention policy.
`Policy Type`	The type of the retention policy. A retention policy type can either be finite, where a specific amount of time to retain the content is known upfront, or indefinite, where the amount of time to retain the content is still unknown.
`Disposition Action`	The disposition action of the retention policy. permanently_delete deletes the content retained by the policy permanently. remove_retention lifts retention policy from the content, allowing it to be deleted by users once the retention policy has expired.
`Retention Type`	Specifies the retention type: modifiable: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. non_modifiable: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies.
`Can Owner Extend Retention`	Whether the owner of a file will be allowed to extend the retention.
`Are Owners Notified`	Whether owner and co-owners of a file are notified when the policy nears expiration.

DELETE

Retention policies: Delete retention policy

Permanently deletes a retention policy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Id`	The ID of the retention policy.
`Response Type`	N/A

GET

Retention policies: Get retention policy

Retrieves a retention policy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Id`	The ID of the retention policy.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Retention policies: List retention policies

Retrieves all of the retention policies for an enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Policy Name`	Filters results by a case sensitive prefix of the name of retention policies.
`Policy Type`	Filters results by the type of retention policy.
`Created By User Id`	Filters results by the ID of the user who created policy.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
`Response Type`	N/A

PUT

Retention policies: Update retention policy

Updates a retention policy.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Id`	The ID of the retention policy.
`Response Type`	N/A

Options (6)

Option Name	Description
`Policy Name`	The name for the retention policy
`Description`	The additional text description of the retention policy.
`Retention Type`	Specifies the retention type: modifiable: You can modify the retention policy. For example, you can add or remove folders, shorten or lengthen the policy duration, or delete the assignment. Use this type if your retention policy is not related to any regulatory purposes. non-modifiable: You can modify the retention policy only in a limited way: add a folder, lengthen the duration, retire the policy, change the disposition action or notification settings. You cannot perform other actions, such as deleting the assignment or shortening the policy duration. Use this type to ensure compliance with regulatory retention policies. When updating a retention policy, you can use non-modifiable type only. You can convert a modifiable policy to non-modifiable, but not the other way around.
`Status`	Used to retire a retention policy. If not retiring a policy, do not include this parameter or set it to null.
`Can Owner Extend Retention`	Determines if the owner of items under the policy can extend the retention when the original retention duration is about to end.
`Are Owners Notified`	Determines if owners and co-owners of items under the policy are notified when the retention duration is about to end.

POST

Retention policy assignments: Assign retention policy

Assigns a retention policy to an item.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name

Description

Policy Id

The ID of the retention policy to assign

Start Date Field

The date the retention policy assignment begins.

If the assigned_to type is metadata_template,
this field can be a date field's metadata attribute key id.

GET

Retention policy assignments: Get file versions under retention

Returns a list of file versions under retention for a retention policy
assignment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Assignment Id`	The ID of the retention policy assignment.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

GET

Retention policy assignments: Get files under retention

Returns a list of files under retention for a retention policy assignment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Assignment Id`	The ID of the retention policy assignment.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

GET

Retention policy assignments: Get retention policy assignment

Retrieves a retention policy assignment

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Assignment Id`	The ID of the retention policy assignment.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Retention policy assignments: List retention policy assignments

Returns a list of all retention policy assignments associated with a specified
retention policy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Id`	The ID of the retention policy.
`Type`	The type of the retention policy assignment to retrieve.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Retention policy assignments: Remove retention policy assignment

Removes a retention policy assignment
applied to content.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Retention Policy Assignment Id`	The ID of the retention policy assignment.
`Response Type`	N/A

POST

Search: Query files/folders by metadata

Create a search using SQL-like syntax to return items that match specific
metadata.

By default, this endpoint returns only the most basic info about the items for
which the query matches. To get additional fields for each item, including any
of the metadata, use the fields attribute in the query.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (6)

Option Name	Description
`From`	Specifies the template used in the query. Must be in the form scope.templateKey. Not all templates can be used in this field, most notably the built-in, Box-provided classification templates can not be used in a query.
`Query`	The query to perform. A query is a logical expression that is very similar to a SQL SELECT statement. Values in the search query can be turned into parameters specified in the query_param arguments list to prevent having to manually insert search values into the query string. For example, a value of :amount would represent the amount value in query_params object.
`Ancestor Folder Id`	The ID of the folder that you are restricting the query to. A value of zero will return results from all folders you have access to. A non-zero value will only return results found in the folder corresponding to the ID or in any of its subfolders.
`Limit`	A value between 0 and 100 that indicates the maximum number of results to return for a single request. This only specifies a maximum boundary and will not guarantee the minimum number of results returned.
`Marker`	Marker to use for requesting the next page.
`Fields`	By default, this endpoint returns only the most basic info about the items for which the query matches. This attribute can be used to specify a list of additional attributes to return for any item, including its metadata. This attribute takes a list of item fields, metadata template identifiers, or metadata template field identifiers. For example: created_by will add the details of the user who created the item to the response. metadata.. will return the mini-representation of the metadata instance identified by the scope and templateKey. metadata... will return all the mini-representation of the metadata instance identified by the scope and templateKey plus the field specified by the field name. Multiple fields for the same scope and templateKey can be defined.

GET

Search: Search for content

Searches for files, folders, web links, and shared files across the
users content or across the entire enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Query`	The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types. This parameter supports a variety of operators to further refine the results returns. "" - by wrapping a query in double quotes only exact matches are returned by the API. Exact searches do not return search matches based on specific character sequences. Instead, they return matches based on phrases, that is, word sequences. For example: A search for "Blue-Box" may return search results including the sequence "blue.box", "Blue Box", and "Blue-Box"; any item containing the words Blue and Box consecutively, in the order specified. AND - returns items that contain both the search terms. For example, a search for marketing AND BoxWorks returns items that have both marketing and BoxWorks within its text in any order. It does not return a result that only has BoxWorks in its text. OR - returns items that contain either of the search terms. For example, a search for marketing OR BoxWorks returns a result that has either marketing or BoxWorks within its text. Using this operator is not necessary as we implicitly interpret multi-word queries as OR unless another supported boolean term is used. NOT - returns items that do not contain the search term provided. For example, a search for marketing AND NOT BoxWorks returns a result that has only marketing within its text. Results containing BoxWorks are omitted. We do not support lower case (that is, and, or, and not) or mixed case (that is, And, Or, and Not) operators. This field is required unless the mdfilters parameter is defined.
`Scope`	Limits the search results to either the files that the user has access to, or to files available to the entire enterprise. The scope defaults to user_content, which limits the search results to content that is available to the currently authenticated user. The enterprise_content can be requested by an admin through our support channels. Once this scope has been enabled for a user, it will allow that use to query for content across the entire enterprise and not only the content that they have access to.
`File Extensions`	Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file extensions without the dots.
`Created At Range`	Limits the search results to any items created within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the the start date is omitted (,2014-05-17T13:35:01-07:00) anything created before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.
`Updated At Range`	Limits the search results to any items updated within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the start date is omitted (,2014-05-17T13:35:01-07:00) anything updated before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00,) the current date will be used as the end date instead.
`Size Range`	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 defined as comma separated list of a lower and upper byte size limit (inclusive). The upper and lower bound can be omitted to create open ranges.
`Owner User Ids`	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 items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. To search across an entire enterprise, we recommend using the enterprise_content scope parameter which can be requested with our support team.
`Recent Updater User Ids`	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. The items still need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users an empty result set will be returned. This feature only searches back to the last 10 versions of an item.
`Ancestor Folder Ids`	Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs. Search results will also include items within any subfolders of those ancestor folders. The folders still need to be owned or shared with the currently authenticated user. If the folder is not accessible by this user, or it does not exist, a HTTP 404 error code will be returned instead. To search across an entire enterprise, we recommend using the enterprise_content scope parameter which can be requested with our support team.
`Content Types`	Limits the search results to any items that match the search query for a specific part of the file, for example the file description. Content types are defined as a comma separated lists of Box recognized content types. The allowed content types are as follows. name - The name of the item, as defined by its name field. description - The description of the item, as defined by its description field. file_content - The actual content of the file. comments - The content of any of the comments on a file or folder. tags - Any tags that are applied to an item, as defined by its tags field.
`Type`	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 of these types. file - Limits the search results to files folder - Limits the search results to folders web_link - Limits the search results to web links, also known as bookmarks
`Trash Content`	Determines if the search should look in the trash for items. By default, this API only returns search results for items not currently in the trash (non_trashed_only). trashed_only - Only searches for items currently in the trash non_trashed_only - Only searches for items currently not in the trash all_items - Searches for both trashed and non-trashed items.
`Mdfilters`	Limits the search results to any items for which the metadata matches the provided filter. This parameter is a list that specifies exactly one metadata template used to filter the search results. The parameter is required unless the query parameter is provided.
`Sort`	Defines the order in which search results are returned. This API defaults to returning items by relevance unless this parameter is explicitly specified. relevance (default) returns the results sorted by relevance to the query search term. The relevance is based on the occurrence of the search term in the items name, description, content, and additional properties. modified_at returns the results ordered in descending order by date at which the item was last modified.
`Direction`	Defines the direction in which search results are ordered. This API defaults to returning items in descending (DESC) order unless this parameter is explicitly specified. When results are sorted by relevance the ordering is locked to returning items in descending order of relevance, and this parameter is ignored.
`Limit`	Defines the maximum number of items to return as part of a page of results.
`Include Recent Shared Links`	Defines whether the search results should include any items that the user recently accessed through a shared link. When this parameter has been set to true, the format of the response of this API changes to return a list of Search Results with Shared Links
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Deleted User Ids`	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 trash_content parameter needs to be set to trashed_only. If searching in trash is not performed, an empty result set is returned. The items need to be owned or shared with the currently authenticated user for them to show up in the search results. If the user does not have access to any files owned by any of the users, an empty result set is returned. Data available from 2023-02-01 onwards.
`Deleted At Range`	Limits the search results to any items deleted within a given date range. Date ranges are defined as comma separated RFC3339 timestamps. If the the start date is omitted (2014-05-17T13:35:01-07:00), anything deleted before the end date will be returned. If the end date is omitted (2014-05-15T13:35:01-07:00), the current date will be used as the end date instead. The trash_content parameter needs to be set to trashed_only. If searching in trash is not performed, then an empty result is returned. Data available from 2023-02-01 onwards.
`Response Type`	N/A

POST

Session termination: Create jobs to terminate user group session

Validates the roles and permissions of the group,
and creates asynchronous jobs
to terminate the group's sessions.
Returns the status for the POST request.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Group Ids`	A list of group IDs

POST

Session termination: Create jobs to terminate users session

Validates the roles and permissions of the user,
and creates asynchronous jobs
to terminate the user's sessions.
Returns the status for the POST request.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`User Ids`	A list of user IDs
`User Logins`	A list of user logins

PUT

Shared links (Files): Add shared link to file

Adds a shared link to a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

GET

Shared links (Files): Find file for shared link

Returns the file represented by a shared link.

A shared file can be represented by a shared link,
which can originate within the current enterprise or within another.

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

The shared_link_permission_options array field can be returned
by requesting it in the fields query parameter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`If-none-match`	Ensures an item is only returned if it has changed. Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Boxapi`	A header containing the shared link and optional password for the shared link. The format for this header is as follows. shared_link=[link]&shared_link_password=[password]
`Response Type`	N/A

GET

Shared links (Files): Get shared link for file

Gets the information for a shared link on a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

PUT

Shared links (Files): Remove shared link from file

Removes a shared link from a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

Options (1)

Option Name	Description
`Shared Link`	By setting this value to null, the shared link is removed from the file.

PUT

Shared links (Files): Update shared link on file

Updates a shared link on a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

PUT

Shared links (Folders): Add shared link to folder

Adds a shared link to a folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

GET

Shared links (Folders): Find folder for shared link

Return the folder represented by a shared link.

A shared folder can be represented by a shared link,
which can originate within the current enterprise or within another.

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`If-none-match`	Ensures an item is only returned if it has changed. Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Boxapi`	A header containing the shared link and optional password for the shared link. The format for this header is as follows. shared_link=[link]&shared_link_password=[password]
`Response Type`	N/A

GET

Shared links (Folders): Get shared link for folder

Gets the information for a shared link on a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

PUT

Shared links (Folders): Remove shared link from folder

Removes a shared link from a folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

Options (1)

Option Name	Description
`Shared Link`	By setting this value to null, the shared link is removed from the folder.

PUT

Shared links (Folders): Update shared link on folder

Updates a shared link on a folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

PUT

Shared links (Web Links): Add shared link to web link

Adds a shared link to a web link.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

GET

Shared links (Web Links): Find web link for shared link

Returns the web link represented by a shared link.

A shared web link can be represented by a shared link,
which can originate within the current enterprise or within another.

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

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`If-none-match`	Ensures an item is only returned if it has changed. Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Boxapi`	A header containing the shared link and optional password for the shared link. The format for this header is as follows. shared_link=[link]&shared_link_password=[password]
`Response Type`	N/A

GET

Shared links (Web Links): Get shared link for web link

Gets the information for a shared link on a web link.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

PUT

Shared links (Web Links): Remove shared link from web link

Removes a shared link from a web link.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

Options (1)

Option Name	Description
`Shared Link`	By setting this value to null, the shared link is removed from the web link.

PUT

Shared links (Web Links): Update shared link on web link

Updates a shared link on a web link.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Fields`	Explicitly request the shared_link fields to be returned for this item.
`Response Type`	N/A

POST

Shield information barrier reports: Create shield information barrier report

Creates a shield information barrier report for a given barrier.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET

Shield information barrier reports: Get shield information barrier report by ID

Retrieves a shield information barrier report by its ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Report Id`	The ID of the shield information barrier Report.
`Response Type`	N/A

GET

Shield information barrier reports: List shield information barrier reports

Lists shield information barrier reports.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Id`	The ID of the shield information barrier.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Shield information barrier segment members: Create shield information barrier segment member

Creates a new shield information barrier segment member.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Type`	-\| A type of the shield barrier segment member.

DELETE

Shield information barrier segment members: Delete shield information barrier segment member by ID

Deletes a shield information barrier
segment member based on provided ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Member Id`	The ID of the shield information barrier segment Member.
`Response Type`	N/A

GET

Shield information barrier segment members: Get shield information barrier segment member by ID

Retrieves a shield information barrier
segment member by its ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Member Id`	The ID of the shield information barrier segment Member.
`Response Type`	N/A

GET

Shield information barrier segment members: List shield information barrier segment members

Lists shield information barrier segment members
based on provided segment IDs.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Id`	The ID of the shield information barrier segment.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Shield information barrier segment restrictions: Create shield information barrier segment restriction

Creates a shield information barrier
segment restriction object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Type`	The type of the shield barrier segment restriction for this member.

DELETE

Shield information barrier segment restrictions: Delete shield information barrier segment restriction by ID

Delete shield information barrier segment restriction
based on provided ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Restriction Id`	The ID of the shield information barrier segment Restriction.
`Response Type`	N/A

GET

Shield information barrier segment restrictions: Get shield information barrier segment restriction by ID

Retrieves a shield information barrier segment
restriction based on provided ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Restriction Id`	The ID of the shield information barrier segment Restriction.
`Response Type`	N/A

GET

Shield information barrier segment restrictions: List shield information barrier segment restrictions

Lists shield information barrier segment restrictions
based on provided segment ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Id`	The ID of the shield information barrier segment.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Shield information barrier segments: Create shield information barrier segment

Creates a shield information barrier segment.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	Name of the shield information barrier segment
`Description`	Description of the shield information barrier segment

DELETE

Shield information barrier segments: Delete shield information barrier segment

Deletes the shield information barrier segment
based on provided ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Id`	The ID of the shield information barrier segment.
`Response Type`	N/A

GET

Shield information barrier segments: Get shield information barrier segment with specified ID

Retrieves shield information barrier segment based on provided ID..

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Id`	The ID of the shield information barrier segment.
`Response Type`	N/A

GET

Shield information barrier segments: List shield information barrier segments

Retrieves a list of shield information barrier segment objects
for the specified Information Barrier ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Id`	The ID of the shield information barrier.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

PUT

Shield information barrier segments: Update shield information barrier segment with specified ID

Updates the shield information barrier segment based on provided ID..

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Segment Id`	The ID of the shield information barrier segment.
`Response Type`	N/A

Options (2)

Option Name	Description
`Name`	The updated name for the shield information barrier segment.
`Description`	The updated description for the shield information barrier segment.

POST

Shield information barriers: Add changed status of shield information barrier with specified ID

Change status of shield information barrier with the specified ID.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Id`	The ID of the shield information barrier.
`Status`	The desired status for the shield information barrier.

POST

Shield information barriers: Create shield information barrier

Creates a shield information barrier to
separate individuals/groups within the same
firm and prevents confidential information passing between them.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET

Shield information barriers: Get shield information barrier with specified ID

Get shield information barrier based on provided ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Shield Information Barrier Id`	The ID of the shield information barrier.
`Response Type`	N/A

GET

Shield information barriers: List shield information barriers

Retrieves a list of shield information barrier objects
for the enterprise of JWT.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Sign requests: Cancel Box Sign request

Cancels a sign request.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sign Request Id`	The ID of the signature request
`Response Type`	N/A

POST

Sign requests: Create Box Sign request

Creates a signature request. This involves preparing a document for signing and
sending the signature request to signers.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (14)

Option Name	Description
`Is Document Preparation Needed`	Indicates if the sender should receive a prepare_url in the response to complete document preparation using the UI.
`Redirect Url`	When specified, the signature request will be redirected to this url when a document is signed.
`Declined Redirect Url`	The uri that a signer will be redirected to after declining to sign a document.
`Are Text Signatures Enabled`	Disables the usage of signatures generated by typing (text).
`Email Subject`	Subject of sign request email. This is cleaned by sign request. If this field is not passed, a default subject will be used.
`Email Message`	Message to include in sign request email. The field is cleaned through sanitization of specific characters. However, some html tags are allowed. Links included in the message are also converted to hyperlinks in the email. The message may contain the following html tags including a, abbr, acronym, b, blockquote, code, em, i, ul, li, ol, and strong. Be aware that when the text to html ratio is too high, the email may end up in spam filters. Custom styles on these tags are not allowed. If this field is not passed, a default message will be used.
`Are Reminders Enabled`	Reminds signers to sign a document on day 3, 8, 13 and 18. Reminders are only sent to outstanding signers.
`Name`	Name of the signature request.
`Days Valid`	Set the number of days after which the created signature request will automatically expire if not completed. By default, we do not apply any expiration date on signature requests, and the signature request does not expire.
`External Id`	This can be used to reference an ID in an external system that the sign request is related to.
`Is Phone Verification Required To View`	Forces signers to verify a text message prior to viewing the document. You must specify the phone number of signers to have this setting apply to them.
`Template Id`	When a signature request is created from a template this field will indicate the id of that template.
`External System Name`	Used as an optional system name to appear in the signature log next to the signers who have been assigned the embed_url_external_id.
`Signature Color`	Force a specific color for the signature (blue, black, or red)

GET

Sign requests: Get Box Sign request by ID

Gets a sign request by ID.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sign Request Id`	The ID of the signature request
`Response Type`	N/A

GET

Sign requests: List Box Sign requests

Gets signature requests created by a user. If the sign_files and/or
parent_folderare deleted, the signature request will not return in the list.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Sign requests: Resend Box Sign request

Resends a signature request email to all outstanding signers.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Sign Request Id`	The ID of the signature request
`Response Type`	N/A

GET

Sign templates: Get Box Sign template by ID

Fetches details of a specific Box Sign template.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Template Id`	The ID of a Box Sign template.
`Response Type`	N/A

GET

Sign templates: List Box Sign templates

Gets Box Sign templates created by a user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Skills: Create Box Skill cards on file

Applies one or more Box Skills metadata cards to a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

Options (1)

Option Name	Description
`Cards`	A list of Box Skill cards to apply to this file.

GET

Skills: List Box Skill cards on file

List the Box Skills metadata cards that are attached to a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

DELETE

Skills: Remove Box Skill cards from file

Removes any Box Skills cards metadata from a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

PUT

Skills: Update Box Skill cards on file

Updates one or more Box Skills metadata cards to a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

Options (3)

Option Name	Description
`Op`	replace
`Path`	The JSON Path that represents the card to replace. In most cases this will be in the format /cards/{index} where index is the zero-indexed position of the card in the list of cards.
`Value`	N/A

PUT

Skills: Update all Box Skill cards on file

An alternative method that can be used to overwrite and update all Box Skill
metadata cards on a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Skill Id`	The ID of the skill to apply this metadata for.
`Response Type`	N/A

Options (1)

Option Name	Description
`Status`	Defines the status of this invocation. Set this to success when setting Skill cards.

GET

Standard and Zones Storage Policies: Get storage policy

Fetches a specific storage policy.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Storage Policy Id`	The ID of the storage policy.
`Response Type`	N/A

GET

Standard and Zones Storage Policies: List storage policies

Fetches all the storage policies in the enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

POST

Standard and Zones Storage Policy Assignments: Assign storage policy

Creates a storage policy assignment for an enterprise or user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET

Standard and Zones Storage Policy Assignments: Get storage policy assignment

Fetches a specific storage policy assignment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Storage Policy Assignment Id`	The ID of the storage policy assignment.
`Response Type`	N/A

GET

Standard and Zones Storage Policy Assignments: List storage policy assignments

Fetches all the storage policy assignment for an enterprise or user.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Resolved For Type`	The target type to return assignments for
`Resolved For Id`	The ID of the user or enterprise to return assignments for
`Response Type`	N/A

DELETE

Standard and Zones Storage Policy Assignments: Unassign storage policy

Delete a storage policy assignment.

Deleting a storage policy assignment on a user
will have the user inherit the enterprise's default
storage policy.

There is a rate limit for calling this endpoint of only
twice per user in a 24 hour time frame.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Storage Policy Assignment Id`	The ID of the storage policy assignment.
`Response Type`	N/A

PUT

Standard and Zones Storage Policy Assignments: Update storage policy assignment

Updates a specific storage policy assignment.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Storage Policy Assignment Id`	The ID of the storage policy assignment.
`Response Type`	N/A

POST

Task assignments: Assign task

Assigns a task to a user.

A task can be assigned to more than one user by creating multiple
assignments.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

GET

Task assignments: Get task assignment

Retrieves information about a task assignment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Assignment Id`	The ID of the task assignment.
`Response Type`	N/A

GET

Task assignments: List task assignments

Lists all of the assignments for a given task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Id`	The ID of the task.
`Response Type`	N/A

DELETE

Task assignments: Unassign task

Deletes a specific task assignment.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Assignment Id`	The ID of the task assignment.
`Response Type`	N/A

PUT

Task assignments: Update task assignment

Updates a task assignment. This endpoint can be
used to update the state of a task assigned to a user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Assignment Id`	The ID of the task assignment.
`Response Type`	N/A

Options (2)

Option Name

Description

Message

An optional message by the assignee that can be added to the task.

Resolution State

The state of the task assigned to the user.

For a task with an action value of complete this can be
incomplete or completed.
For a task with an action of review this can be
incomplete, approved, or rejected.

POST

Tasks: Create task

Creates a single task on a file. This task is not assigned to any user and
will need to be assigned separately.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (4)

Option Name	Description
`Action`	The action the task assignee will be prompted to do. Must be review defines an approval task that can be approved or rejected complete defines a general task which can be completed
`Message`	An optional message to include with the task.
`Due At`	Defines when the task is due. Defaults to null if not provided.
`Completion Rule`	Defines which assignees need to complete this task before the task is considered completed. all_assignees (default) requires all assignees to review or approve the the task in order for it to be considered completed. any_assignee accepts any one assignee to review or approve the the task in order for it to be considered completed.

GET

Tasks: Get task

Retrieves information about a specific task.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Id`	The ID of the task.
`Response Type`	N/A

GET

Tasks: List tasks on file

Retrieves a list of all the tasks for a file. This
endpoint does not support pagination.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

DELETE

Tasks: Remove task

Removes a task from a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Id`	The ID of the task.
`Response Type`	N/A

PUT

Tasks: Update task

Updates a task. This can be used to update a task's configuration, or to
update its completion state.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Task Id`	The ID of the task.
`Response Type`	N/A

Options (4)

Option Name	Description
`Action`	The action the task assignee will be prompted to do. Must be review defines an approval task that can be approved or rejected complete defines a general task which can be completed
`Message`	The message included with the task.
`Due At`	When the task is due at.
`Completion Rule`	Defines which assignees need to complete this task before the task is considered completed. all_assignees (default) requires all assignees to review or approve the the task in order for it to be considered completed. any_assignee accepts any one assignee to review or approve the the task in order for it to be considered completed.

POST

Terms of service user statuses: Create terms of service status for new user

Sets the status for a terms of service for a user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Is Accepted`	Whether the user has accepted the terms.

GET

Terms of service user statuses: List terms of service user statuses

Retrieves an overview of users and their status for a
terms of service, including Whether they have accepted
the terms and when.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tos Id`	The ID of the terms of service.
`User Id`	Limits results to the given user ID.
`Response Type`	N/A

PUT

Terms of service user statuses: Update terms of service status for existing user

Updates the status for a terms of service for a user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Terms Of Service User Status Id`	The ID of the terms of service status.
`Response Type`	N/A

Options (1)

Option Name	Description
`Is Accepted`	Whether the user has accepted the terms.

POST

Terms of service: Create terms of service

Creates a terms of service for a given enterprise
and type of user.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name

Description

Status

Whether this terms of service is active.

Tos Type

The type of user to set the terms of
service for.

Text

The terms of service text to display to users.

The text can be set to empty if the status is set to disabled.

GET

Terms of service: Get terms of service

Fetches a specific terms of service.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Terms Of Service Id`	The ID of the terms of service.
`Response Type`	N/A

GET

Terms of service: List terms of services

Returns the current terms of service text and settings
for the enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Tos Type`	Limits the results to the terms of service of the given type.
`Response Type`	N/A

PUT

Terms of service: Update terms of service

Updates a specific terms of service.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Terms Of Service Id`	The ID of the terms of service.
`Response Type`	N/A

Options (2)

Option Name

Description

Status

Whether this terms of service is active.

Text

The terms of service text to display to users.

The text can be set to empty if the status is set to disabled.

PUT

Transfer folders: Transfer owned folders

Move all of the items (files, folders and workflows) owned by a user into
another user's account

Only the root folder (0) can be transferred.

Folders can only be moved across users by users with administrative
permissions.

All existing shared links and folder-level collaborations are transferred
during the operation. Please note that while collaborations at the individual
file-level are transferred during the operation, the collaborations are
deleted when the original user is deleted.

This call will be performed synchronously which might lead to a slow response
when the source user has a large number of items in all of its folders.

If the destination path has a metadata cascade policy attached to any of
the parent folders, a metadata cascade operation will be kicked off
asynchronously.

There is currently no way to check for when this operation is finished.

The destination folder's name will be in the format `{User}'s Files and
Folders, where {User}` is the display name of the user.

To make this API call your application will need to have the "Read and write
all files and folders stored in Box" scope enabled.

Please make sure the destination user has access to Relay or Relay Lite,
and has access to the files and folders involved in the workflows being
transferred.

Admins will receive an email when the operation is completed.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Notify`	Determines if users should receive email notification for the action performed.
`Response Type`	N/A

GET

Trashed files: Get trashed file

Retrieves a file that has been moved to the trash.

Please note that only if the file itself has been moved to the
trash can it be retrieved with this API call. If instead one of
its parent folders was moved to the trash, only that folder
can be inspected using the
GET /folders/:id/trashAPI.

To list all items that have been moved to the trash, please
use the GET /folders/trash/items
API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

DELETE

Trashed files: Permanently remove file

Permanently deletes a file that is in the trash.
This action cannot be undone.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

POST

Trashed files: Restore file

Restores a file that has been moved to the trash.

An optional new parent ID can be provided to restore the file to in case the
original folder has been deleted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	An optional new name for the file.

GET

Trashed folders: Get trashed folder

Retrieves a folder that has been moved to the trash.

Please note that only if the folder itself has been moved to the
trash can it be retrieved with this API call. If instead one of
its parent folders was moved to the trash, only that folder
can be inspected using the
GET /folders/:id/trashAPI.

To list all items that have been moved to the trash, please
use the GET /folders/trash/items
API.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

DELETE

Trashed folders: Permanently remove folder

Permanently deletes a folder that is in the trash.
This action cannot be undone.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

POST

Trashed folders: Restore folder

Restores a folder that has been moved to the trash.

An optional new parent ID can be provided to restore the folder to in case the
original folder has been deleted.

During this operation, part of the file tree will be locked, mainly
the source folder and all of its descendants, as well as the destination
folder.

For the duration of the operation, no other move, copy, delete, or restore
operation can performed on any of the locked folders.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	An optional new name for the folder.

GET

Trashed items: List trashed items

Retrieves the files and folders that have been moved
to the trash.

Any attribute in the full files or folders objects can be passed
in with the fields parameter to retrieve those specific
attributes that are not returned by default.

This endpoint defaults to use offset-based pagination, yet also supports
marker-based pagination using the marker parameter.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Limit`	The maximum number of items to return per page.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Usemarker`	Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Direction`	The direction to sort results in. This can be either in alphabetical ascending (ASC) or descending (DESC) order.
`Sort`	Defines the second attribute by which items are sorted. Items are always sorted by their type first, with folders listed before files, and files listed before web links. This parameter is not supported when using marker-based pagination.
`Response Type`	N/A

GET

Trashed web links: Get trashed web link

Retrieves a web link that has been moved to the trash.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

DELETE

Trashed web links: Permanently remove web link

Permanently deletes a web link that is in the trash.
This action cannot be undone.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Response Type`	N/A

POST

Trashed web links: Restore web link

Restores a web link that has been moved to the trash.

An optional new parent ID can be provided to restore the web link to in case
the original folder has been deleted.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (1)

Option Name	Description
`Name`	An optional new name for the web link.

POST

Uploads (Chunked): Commit upload session

Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the Create upload session
and Get upload session endpoints.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Session Id`	The ID of the upload session.
`Digest`	The [RFC3230][1] message digest of the whole file. Only SHA1 is supported. The SHA1 digest must be Base64 encoded. The format of this header is as sha=BASE64_ENCODED_DIGEST. [1]: https://tools.ietf.org/html/rfc3230
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`If-none-match`	Ensures an item is only returned if it has changed. Pass in the item's last observed etag value into this header and the endpoint will fail with a 304 Not Modified if the item has not changed since.
`Response Type`	N/A

POST

Uploads (Chunked): Create upload session

Creates an upload session for a new file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Folder Id`	The ID of the folder to upload the new file to.
`File Size`	The total number of bytes of the file to be uploaded
`File Name`	The name of new file

POST

Uploads (Chunked): Create upload session for existing file

Creates an upload session for an existing file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

Options (2)

Option Name	Description
`File Size`	The total number of bytes of the file to be uploaded
`File Name`	The optional new name of new file

GET

Uploads (Chunked): Get upload session

Return information about an upload session.

The actual endpoint URL is returned by the Create upload session endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Session Id`	The ID of the upload session.
`Response Type`	N/A

GET

Uploads (Chunked): List parts

Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the Create upload session
and Get upload session endpoints.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Session Id`	The ID of the upload session.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Uploads (Chunked): Remove upload session

Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the Create upload session
and Get upload session endpoints.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Session Id`	The ID of the upload session.
`Response Type`	N/A

PUT

Uploads (Chunked): Upload part of file

Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the Create upload session
and Get upload session endpoints.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Upload Session Id`	The ID of the upload session.
`Digest`	The [RFC3230][1] message digest of the chunk uploaded. Only SHA1 is supported. The SHA1 digest must be base64 encoded. The format of this header is as sha=BASE64_ENCODED_DIGEST. To get the value for the SHA digest, use the openSSL command to encode the file part: openssl sha1 -binary \| base64 [1]: https://tools.ietf.org/html/rfc3230
`Content-range`	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 equal in size to the part size specified in the upload session that you created. One exception is the last part of the file, as this can be smaller. When providing the value for content-range, remember that: The lower bound of each part's byte range must be a multiple of the part size. The higher bound must be a multiple of the part size - 1.
`Response Type`	N/A

Options (1)

Option Name	Description
`Options`	N/A

POST

Uploads: Upload file

Uploads a small file to Box. For file sizes over 50MB we recommend
using the Chunk Upload APIs.

The attributes part of the body must come before the
filepart. Requests that do not follow this format when
uploading the file will receive a HTTP 400 error with a
metadata_after_file_contentserror code.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Content-md5`	An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.
`Response Type`	N/A

Options (1)

Option Name

Description

File

The content of the file to upload to Box.

The attributes part of the body must come before the
file part. Requests that do not follow this format when
uploading the file will receive a HTTP 400 error with a
metadata_after_file_contents error code.

POST

Uploads: Upload file version

Update a file's content. For file sizes over 50MB we recommend
using the Chunk Upload APIs.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`If-match`	Ensures this item hasn't recently changed before making changes. Pass in the item's last observed etag value into this header and the endpoint will fail with a 412 Precondition Failed if it has changed since.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Content-md5`	An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.
`Response Type`	N/A

Options (1)

Option Name

Description

File

The content of the file to upload to Box.

POST

User avatars: Add or update user avatar

Adds or updates a user avatar.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Response Type`	N/A

Options (1)

Option Name	Description
`Pic`	The image file to be uploaded to Box. Accepted file extensions are .jpg or .png. The maximum file size is 1MB.

DELETE

User avatars: Delete user avatar

Removes an existing user avatar.
You cannot reverse this operation.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Response Type`	N/A

GET

User avatars: Get user avatar

Retrieves an image of a the user's avatar.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Response Type`	N/A

POST

Users: Create user

Creates a new managed user in an enterprise. This endpoint
is only available to users and applications with the right
admin permissions.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (17)

Option Name	Description
`Name`	The name of the user
`Login`	The email address the user uses to log in Required, unless is_platform_access_only is set to true.
`Is Platform Access Only`	Specifies that the user is an app user.
`Role`	The user’s enterprise role
`Language`	The language of the user, formatted in modified version of the ISO 639-1 format.
`Is Sync Enabled`	Whether the user can use Box Sync
`Job Title`	The user’s job title
`Phone`	The user’s phone number
`Address`	The user’s address
`Space Amount`	The user’s total available space in bytes. Set this to -1 to indicate unlimited storage.
`Can See Managed Users`	Whether the user can see other enterprise users in their contact list
`Timezone`	The user's timezone
`Is External Collab Restricted`	Whether the user is allowed to collaborate with users outside their enterprise
`Is Exempt From Device Limits`	Whether to exempt the user from enterprise device limits
`Is Exempt From Login Verification`	Whether the user must use two-factor authentication
`Status`	The user's account status
`External App User Id`	An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users.

DELETE

Users: Delete user

Deletes a user. By default this will fail if the user
still owns any content. Move their owned content first
before proceeding, or use the force field to delete
the user and their files.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Notify`	Whether the user will receive email notification of the deletion
`Force`	Whether the user should be deleted even if this user still own files
`Response Type`	N/A

GET

Users: Get current user

Retrieves information about the user who is currently authenticated.

In the case of a client-side authenticated OAuth 2.0 application
this will be the user who authorized the app.

In the case of a JWT, server-side authenticated application
this will be the service account that belongs to the application
by default.

Use the As-User header to change who this API call is made on behalf of.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Users: Get user

Retrieves information about a user in the enterprise.

The application and the authenticated user need to
have the permission to look up users in the entire
enterprise.

This endpoint also returns a limited set of information
for external users who are collaborated on content
owned by the enterprise for authenticated users with the
right scopes. In this case, disallowed fields will return
null instead.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

GET

Users: List enterprise users

Returns a list of all users for the Enterprise along with their user_id,
public_name, and login.

The application and the authenticated user need to
have the permission to look up users in the entire
enterprise.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Filter Term`	Limits the results to only users who's name or login start with the search term. For externally managed users, the search term needs to completely match the in order to find the user, and it will only return one user at a time.
`User Type`	Limits the results to the kind of user specified. all returns every kind of user for whom the login or name partially matches the filter_term. It will only return an external user if the login matches the filter_term completely, and in that case it will only return that user. managed returns all managed and app users for whom the login or name partially matches the filter_term. external returns all external users for whom the login matches the filter_term exactly.
`External App User Id`	Limits the results to app users with the given external_app_user_id value. When creating an app user, an external_app_user_id value can be set. This value can then be used in this endpoint to find any users that match that external_app_user_id value.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Offset`	The offset of the item at which to begin the response. Queries with offset parameter value exceeding 10000 will be rejected with a 400 response.
`Limit`	The maximum number of items to return per page.
`Usemarker`	Specifies whether to use marker-based pagination instead of offset-based pagination. Only one pagination method can be used at a time. By setting this value to true, the API will return a marker field that can be passed as a parameter to this endpoint to get the next page of the response.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Response Type`	N/A

PUT

Users: Update user

Updates a managed or app user in an enterprise. This endpoint
is only available to users and applications with the right
admin permissions.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`User Id`	The ID of the user.
`Fields`	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 standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.
`Response Type`	N/A

Options (19)

Option Name	Description
`Enterprise`	Set this to null to roll the user out of the enterprise and make them a free user
`Notify`	Whether the user should receive an email when they are rolled out of an enterprise
`Name`	The name of the user
`Login`	The email address the user uses to log in Note: If the target user's email is not confirmed, then the primary login address cannot be changed.
`Role`	The user’s enterprise role
`Language`	The language of the user, formatted in modified version of the ISO 639-1 format.
`Is Sync Enabled`	Whether the user can use Box Sync
`Job Title`	The user’s job title
`Phone`	The user’s phone number
`Address`	The user’s address
`Can See Managed Users`	Whether the user can see other enterprise users in their contact list
`Timezone`	The user's timezone
`Is External Collab Restricted`	Whether the user is allowed to collaborate with users outside their enterprise
`Is Exempt From Device Limits`	Whether to exempt the user from enterprise device limits
`Is Exempt From Login Verification`	Whether the user must use two-factor authentication
`Is Password Reset Required`	Whether the user is required to reset their password
`Status`	The user's account status
`Space Amount`	The user’s total available space in bytes. Set this to -1 to indicate unlimited storage.
`External App User Id`	An external identifier for an app user, which can be used to look up the user. This can be used to tie user IDs from external identity providers to Box users. Note: In order to update this field, you need to request a token using the application that created the app user.

PUT

Watermarks (Files): Apply watermark to file

Applies or update a watermark on a file.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

GET

Watermarks (Files): Get watermark on file

Retrieve the watermark for a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

DELETE

Watermarks (Files): Remove watermark from file

Removes the watermark from a file.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`File Id`	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 the ID from the URL. For example, for the URL https://*.app.box.com/files/123 the file_id is 123.
`Response Type`	N/A

PUT

Watermarks (Folders): Apply watermark to folder

Applies or update a watermark on a folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

GET

Watermarks (Folders): Get watermark for folder

Retrieve the watermark for a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

DELETE

Watermarks (Folders): Remove watermark from folder

Removes the watermark from a folder.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Response Type`	N/A

POST

Web links: Create web link

Creates a web link object within a folder.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (3)

Option Name	Description
`Url`	The URL that this web link links to. Must start with "http://" or "https://".
`Name`	Name of the web link. Defaults to the URL if not set.
`Description`	Description of the web link.

GET

Web links: Get web link

Retrieve information about a web link.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Boxapi`	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 shared with a user. Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password]. This header can be used on the file or folder shared, as well as on any files or folders nested within the item.
`Response Type`	N/A

DELETE

Web links: Remove web link

Deletes a web link.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Response Type`	N/A

PUT

Web links: Update web link

Updates a web link object.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Web Link Id`	The ID of the web link.
`Response Type`	N/A

Options (3)

Option Name	Description
`Url`	The new URL that the web link links to. Must start with "http://" or "https://".
`Name`	A new name for the web link. Defaults to the URL if not set.
`Description`	A new description of the web link.

POST

Webhooks: Create webhook

Creates a webhook.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (2)

Option Name	Description
`Address`	The URL that is notified by this webhook
`Triggers`	An array of event names that this webhook is to be triggered for

GET

Webhooks: Get webhook

Retrieves a specific webhook

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhook Id`	The ID of the webhook.
`Response Type`	N/A

GET

Webhooks: List all webhooks

Returns all defined webhooks for the requesting application.

This API only returns webhooks that are applied to files or folders that are
owned by the authenticated user. This means that an admin can not see webhooks
created by a service account unless the admin has access to those folders, and
vice versa.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Limit`	The maximum number of items to return per page.
`Response Type`	N/A

DELETE

Webhooks: Remove webhook

Deletes a webhook.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhook Id`	The ID of the webhook.
`Response Type`	N/A

PUT

Webhooks: Update webhook

Updates a webhook.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Webhook Id`	The ID of the webhook.
`Response Type`	N/A

Options (2)

Option Name	Description
`Address`	The URL that is notified by this webhook
`Triggers`	An array of event names that this webhook is to be triggered for

GET

Workflows: List workflows

Returns list of workflows that act on a given folder ID, and
have a flow with a trigger type of WORKFLOW_MANUAL_START.

You application must be authorized to use the Manage Box Relay application
scope within the developer console in to use this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Folder Id`	The unique identifier that represent a folder. The ID for any folder can be determined by visiting this folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folder/123 the folder_id is 123. The root folder of a Box account is always represented by the ID 0.
`Trigger Type`	Type of trigger to search for.
`Limit`	The maximum number of items to return per page.
`Marker`	Defines the position marker at which to begin returning results. This is used when paginating using marker-based pagination. This requires usemarker to be set to true.
`Response Type`	N/A

POST

Workflows: Starts workflow based on request body

Initiates a flow with a trigger type of WORKFLOW_MANUAL_START.

You application must be authorized to use the Manage Box Relay application
scope within the developer console.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Workflow Id`	The ID of the workflow.
`Response Type`	N/A

Options (1)

Option Name	Description
`Type`	The type of the parameters object

POST

Zip Downloads: Create zip download

Creates a request to download multiple files and folders as a single zip
archive file. This API does not return the archive but instead performs all
the checks to ensure that the user has access to all the items, and then
returns a download_url and a status_url that can be used to download the
archive.

The limit for an archive is either the Account's upload limit or
10,000 files, whichever is met first.

Note: Downloading a large file can be
affected by various
factors such as distance, network latency,
bandwidth, and congestion, as well as packet loss
ratio and current server load.
For these reasons we recommend that a maximum ZIP archive
total size does not exceed 25GB.

Parameters

Parameter Name	Description
`Content Type`	N/A
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Response Type`	N/A

Options (1)

Option Name	Description
`Download File Name`	The optional name of the zip archive. This name will be appended by the .zip file extension, for example January Financials.zip.

GET

Zip Downloads: Download zip archive

Returns the contents of a zip archive in binary format. This URL does not
require any form of authentication and could be used in a user's browser to
download the archive to a user's device.

By default, this URL is only valid for a few seconds from the creation of
the request for this archive. Once a download has started it can not be
stopped and resumed, instead a new request for a zip archive would need to
be created.

The URL of this endpoint should not be considered as fixed. Instead, use
the Create zip download API to request to create a
ziparchive, and then follow the download_url field in the response to
this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Zip Download Id`	The unique identifier that represent this zip archive.
`Response Type`	N/A

GET

Zip Downloads: Get zip download status

Returns the download status of a zip archive, allowing an application to
inspect the progress of the download as well as the number of items that
might have been skipped.

This endpoint can only be accessed once the download has started.
Subsequently this endpoint is valid for 12 hours from the start of the
download.

The URL of this endpoint should not be considered as fixed. Instead, use
the Create zip download API to request to create a
ziparchive, and then follow the status_url field in the response to
this endpoint.

Parameters

Parameter Name	Description
`headers`	N/A
`headers.Header Key`	N/A
`headers.Header Value`	N/A
`Zip Download Id`	The unique identifier that represent this zip archive.
`Response Type`	N/A