• Installs:
  • Today: 0
  • This Week: 0
  • This Month: 1
  • All Time: 7160
Developer:userzakutynsky

Box API Package

Manage, share, and upload files to the cloud.

List of Endpoints
This is the list of endpoints this API includes. To add of the endpoints to your app, please click on “Connect to endpoint” text.
See All
List of Webhook Events
This is the list of webhook events this API provides. Webhooks allow you to register to certain events and receive real-time data over websockets.
See All
Discussions
See All
Readme

Box

Box Package

Connect to the Box Cloud Storage API to manage, share, and upload files to the cloud. Test an API call in your browser and export the code snippet into your app.

  • Domain: box.com
  • Credentials: clientId, clientSecret

How to get credentials:

  1. Navigate to your Box Developer Console
  2. On the left hand side, select Configuration
  3. Use your OAuth 2.0 Credentials to call the getAccessToken function

Custom datatypes:

DatatypeDescriptionExample
DatepickerString which includes date and time2016-05-28 00:00:00
MapString which includes latitude and longitude coma separated50.37, 26.56
ListSimple array["123", "sample"]
SelectString with predefined valuessample
ArrayArray of objects[{"Second name":"123","Age":"12","Photo":"sdf","Draft":"sdfsdf"},{"name":"adi","Second name":"bla","Age":"4","Photo":"asfserwe","Draft":"sdfsdf"}]

Webhook credentials

Please use SDK to test this feature.

  1. Go to RapidAPI
  2. Log in or create an account
  3. Go to My apps
  4. Add new project with projectName to get your project Key
FieldTypeDescription
projectNamecredentialsYour RapidAPI project name
projectKeycredentialsYour RapidAPI project key

Box.getAccessToken

Returns access tokens. An access token is a data 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 Box authorize endpoint and Box will send you an authorization code. You will then send the authorization code to the token endpoint in a request for an access token. You can then use the returned access token to make Box API calls.

FieldTypeDescription
codeStringThe authorization code returned by Box in response to a successfull authentication request.
clientIdcredentialsThe client ID of the application requesting authentication. 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 Parameters section of the configuration page, find the item labeled
clientSecretcredentialsThe client secret of the application requesting authentication. To get the client secret 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 Parameters section of the configuration page, find the item labeled

Box.revokeAccessToken

Revoke endpoint, the endpoint that revokes access tokens, or to put it another way, the endpoint that ends sessions, logging users out.

FieldTypeDescription
tokenStringAn access token or refresh token supplied by Box in response to a token request. When either token is supplied with this request, both will be revoked.
clientIdcredentialsThe client ID of the application requesting authentication. 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 Parameters section of the configuration page, find the item labeled
clientSecretcredentialsThe client secret of the application requesting authentication. To get the client secret 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 Parameters section of the configuration page, find the item labeled

Box.getFileInfo

Get information about a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
fieldsListComma-separated list of fields to include in the response

Box.downloadFile

Retrieves the actual data of the file. An optional version parameter can be set to download a previous version of the file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
versionStringOptional file version ID to download (defaults to the current version)
rangeStringThe range value in bytes. Format should be bytes={start_range}-{end_range}
boxApiStringUse the format shared_link=SHARED_LINK_URL or shared_link=SHARED_LINK_URL&shared_link_password=PASSWORD

Box.uploadFile

Use the Upload API to allow users to add a new file. The user can then upload a file by specifying the destination folder for the file. If the user provides a file name that already exists in the destination folder, the user will receive an error.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileFileUploaded file
parentIdStringThe ID of the parent folder. Use 0 for the root folder.

Box.uploadFileVersion

Uploading a new file version is performed in the same way as uploading a file. This method is used to upload a new version of an existing file in a user’s account. Similar to regular file uploads, these are performed as multipart form uploads.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
fileFileUploaded file
nameStringNew file name

Box.verifyFileAcceptance

Verify that a file will be accepted by Box before you send all the bytes over the wire.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
nameStringFile name
parentIdStringThe ID of the parent folder. Use 0 for the root folder.
sizeNumberThe size of the file in bytes

Box.updateFileInfo

Update the information about a file, including renaming or moving the file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
nameStringThe new name for the file
descriptionStringThe new description for the file
parentIdStringThe ID of the parent folder. Use '0' for the root folder.
sharedLinkAccessSelectThe level of access. Can be open ('People with the link'), company ('People in your company'), or collaborators ('People in this folder'). If you omit this field then the access level will be set to the default access level specified by the enterprise admin.
sharedLinkPasswordStringThe password required to access the shared link. Set to null to remove the password.
sharedLinkUnsharedAtStringThe date-time that this link will become disabled. This field can only be set by users with paid accounts.
sharedLinkPermissionsCanDownloadStringWhether the shared link allows downloads. Can only be set with access levels open and company (not collaborators).
tagsStringAll tags attached to this file. To add/remove a tag to/from a file, you can first get the file’s current tags (be sure to specify ?fields=tags, since the tags field is not returned by default); then modify the list as required; and finally, set the file’s entire list of tags.
fieldsListComma-separated list of fields to include in the response

Box.deleteFile

Move a file to the trash.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id

Box.copyFile

Copy a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
parentIdStringThe ID of the destination folder
nameStringAn optional new name for the file

Box.lockFile

Lock a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
lockExpiresAtDatePickerThe time the lock expires
lockIsDownloadPreventedBooleanWhether or not the file can be downloaded while locked

Box.unlockFile

Unlock a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id

Box.getFileThumbnail

Get a thumbnail image for a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
minHeightNumberThe minimum height of the thumbnail
minWidthNumberThe minimum width of the thumbnail
maxHeightNumberThe maximum height of the thumbnail
maxWidthNumberThe maximum width of the thumbnail

Box.getFileEmbedLink

Get a URL for creating an embedded preview session.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id

Box.getFileCollaborations

Get all of the collaborations on a file (i.e. all of the users that have access to that file).

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
fieldsListComma-separated list of fields to include in the response
markerStringThe position marker at which to begin the response
limitNumberThe maximum number of items to return

Box.getFileComments

Get all of the comments on a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return

Box.getFileTasks

Get all of the tasks for a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 1,000 and the maximum is 1,000.

Box.getFileVersions

Get information on prior versions of a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return

Box.promoteFileVersion

Copy a previous file version and make it the current version of the file. This create a copy of the old file version and puts it on the top of the versions stack. The file will have the exact same contents, the same SHA-1/etag, and the same name as the original. Other properties such as comments do not get updated to their former values.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
idStringThe ID of the file version to make current
fieldsListComma-separated list of fields to include in the response

Box.deleteOldFileVersion

Discards a file version to the trash.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile Id
idStringThe ID of the file version.

Box.getFolderInfo

Get information about a folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder Id. The root folder of a Box account is always represented by the ID 0.
fieldsListComma-separated list of fields to include in the response

Box.getFolderItems

Gets all of the files, folders, or web links contained within this folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder Id
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.createFolder

Create a new folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
nameStringThe desired name for the folder
parentIdStringThe ID of the parent folder

Box.updateFolder

Update a folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder Id
fieldsListComma-separated list of fields to include in the response
nameStringThe desired name for the folder
descriptionStringThe description of the folder
parentIdStringThe ID of the parent folder
sharedLinkAccessSelectThe level of access. Can be open ('People with the link'), company ('People in your company'), or collaborators ('People in this folder'). If you omit this field then the access level will be set to the default access level specified by the enterprise admin.
sharedLinkPasswordStringThe password required to access the shared link. Set to null to remove the password.
sharedLinkUnsharedAtStringThe date-time that this link will become disabled. This field can only be set by users with paid accounts.
sharedLinkPermissionsCanDownloadBooleanWhether the shared link allows downloads. For shared links on folders, this also applies to any items in the folder. Can only be set with access levels open and company (not collaborators)
ownedByIdStringThe ID of the user (should be your own user ID)
syncStateStringWhether Box Sync clients will sync this folder. Values of synced or not_synced can be sent, while partially_synced may also be returned.
tagsStringAll tags attached to this folder. To add/remove a tag to/from a folder, you can first get the folder’s current tags (be sure to specify ?fields=tags, since the tags field is not returned by default); then modify the list as required; and finally, set the folder’s entire list of tags.

Box.deleteFolder

Move a folder to the trash. The recursive parameter must be included in order to delete folders that aren't empty.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder id
recursiveBooleanWhether to delete this folder if it has items inside of it.

Box.copyFolder

Used to create a copy of a folder in another folder. The original version of the folder will not be altered.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder id
parentIdStringThe ID of the destination folder
fieldsListComma-separated list of fields to include in the response
nameStringAn optional new name for the folder

Box.getFolderCollaborations

Use this to get a list of all the collaborations on a folder i.e. all of the users that have access to that folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder id
fieldsListComma-separated list of fields to include in the response

Box.getFileSharedLink

Get the shared link for a file or folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringThe ID of the file or folder
endpointSelectfiles or folders

Box.createFileSharedLink

Create the shared link for a file or folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
idStringThe ID of the file or folder
endpointStringfiles or folders
sharedLinkAccessSelectThe level of access. Can be open ('People with the link'), company ('People in your company'), or collaborators ('People in this folder'). If you omit this field then the access level will be set to the default access level specified by the enterprise admin.
sharedLinkPasswordStringThe password required to access the shared link. Set to null to remove the password.
sharedLinkUnsharedAtStringThe date-time that this link will become disabled. This field can only be set by users with paid accounts.
sharedLinkPermissionsCanDownloadBooleanWhether the shared link allows downloads. For shared links on folders, this also applies to any items in the folder. Can only be set with access levels open and company (not collaborators).

Box.updateFileSharedLink

Update the shared link for a file or folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
idStringThe ID of the file or folder
endpointSelectfiles or folders
sharedLinkAccessSelectThe level of access. Can be open ('People with the link'), company ('People in your company'), or collaborators ('People in this folder'). If you omit this field then the access level will be set to the default access level specified by the enterprise admin.
sharedLinkPasswordStringThe password required to access the shared link. Set to null to remove the password.
sharedLinkUnsharedAtStringThe date-time that this link will become disabled. This field can only be set by users with paid accounts.
sharedLinkPermissionsCanDownloadBooleanCan be open or collaborators

Box.getSharedItem

Use this API to obtain the ID of a file or folder from a shared link URL. Pass the URL (and password, if needed) in the BoxApi header. Once you have the ID of the file or folder, you can call any API to access that file or folder a long as you also pass the BoxApi header to those APIs. The header must be passed in each API call since your account would not otherwise have permission to access the shared item. Passing the shared link URL validates that the item was shared with you (e.g. via email or any other channel).

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
sharedLinkUrlStringUrl of shared link
sharedLinkPasswordStringPassword of shared link

Box.getTrashedItems

Gets the files, folders and web links that are in the user's trash.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getSingleTrashedItem

Get an item that has been moved to the trash.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
idStringThe ID of the file, folder or web link
endpointSelectfiles, folders or web_links
fieldsListComma-separated list of fields to include in the response

Box.restoreTrashedItem

Restores an item that has been moved to the trash.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
idStringThe ID of the file, folder or web link
endpointSelectfiles, folders or web_links
fieldsListComma-separated list of fields to include in the response
parentIdStringThe ID of the new parent folder. Only used if the previous parent folder no longer exists or the user doesn't have permission to restore the item there.
nameStringThe new name for this item. Only used if the item can't be restored with its previous name due to a conflict.

Box.permanentlyDeleteItem

Permanently delete an item that is in the trash. The item will no longer exist in Box. This action cannot be undone.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
idStringThe ID of the file, folder or web link
endpointSelectfiles, folders or web_links

Box.searchContent

The search endpoint provides a powerful way to find Box content. Use the parameters described in this section to control what you search for.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
queryStringThe string to search for. Box matches the search string against object names, descriptions, text contents of files, and other data.
scopeStringThe scope on which you want search. Can be user_content for a search limited to the current user or enterprise_content to search an entire enterprise.
fileExtensionsListLimit searches to specific file extensions like pdf,png, or doc. The value can be a single file extension or a comma-delimited list of extensions. For example: png,md,pdf
createdAtRangeDatePickerThe date when the item was created. Specify the date range using RFC3339 timestamps separated by a comma. For example: `2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00. Either the beginning date or the ending date may be empty, but the separating comma is required. For example, if you omit the beginning date, then the ending date must begin with a comma.
updatedAtRangeDatePickerThe date when the item was updated. Specify the date range using RFC3339 timestamps separated by a comma. For example: 2014-05-15T13:35:01-07:00,2014-05-17T13:35:01-07:00. Either the beginning date or the ending date may be empty, but the separating comma is required. For example, if you omit the beginning date, then the ending date must begin with a comma.
sizeRangeStringReturn only files within a stated size range. Specify the range in bytes with lower and upper bounds separated by a comma, like so:lower_bound_size,upper_bound_size, where 1MB is 1,000,000 bytes. You can specify only the lower bound if you end this parameter with a comma. You can specify only the upper bound by placing a comma at the beginning of the number.
ownerUserIdsListSearch for objects by owner. Requires a user ID or a set of comma-delimited user IDs, like so: user_id_1,user_id_2
ancestorFolderIdsListSearch for the contents of specific folders (and folders within them). Requires a folder ID or a set of comma-delimited folder IDs, like so: folder_id_1,folder_id_2
contentTypesListSearch for objects of specified content types. The types can be name, description, file_content, comments, or tags. Requires a content type or a set of comma-delimited content_types, like so: content_type_1,content_type_2
typeStringThe type of objects you want to include in the search results. The type can be file, folder, or web_link
trashContentSelectControls whether to search in the trash. The value can be trashed_only or non_trashed_only. Searches without this parameter default to searching non_trashed_only
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getMetadataTemplate

Get information about a metadata template.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
scopeStringThe scope of the object. Global and enterprise scopes are supported. The Global scope contains the properties template, while the enterprise scope pertains to custom template within the enterprise.
templateStringA unique identifier for the template. The identifier must be unique across the scope of the enterprise to which the metadata template is being applied. The character limit is 64 and is validated by this regex: ^[a-zA-Z_][-a-zA-Z0-9_]*$

Box.createMetadataTemplate

Create a new metadata template with the specified schema.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
scopeStringThe scope of the object. Only the enterprise scope is supported.
templateKeyStringA unique identifier for the template. The identifier must be unique across the scope of the enterprise to which the metadata template is being applied to. Defaults to a string derived from the displayName if no value is provided.
displayNameStringThe display name of the template.
hiddenBooleanWhether this template is hidden in the UI. Defaults to false.
fieldTypeSelectThe data type of the field's value. Templates support four attributes types: string, enum, float, and date (RFC 3339).
fieldKeyStringA unique identifier for the field. The identifier must be unique within the template to which it belongs. Defaults to a string derived from the displayName if no value is provided.
fieldDisplayNameStringThe display name of the field

Box.getEnterpriseTemplates

Used to retrieve all metadata templates within a user's enterprise. Only the enterprise scope is supported.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
markerStringThe position marker at which to begin the response. See marker-based paging for details.
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getFileAllMetadata

Used to retrieve all metadata associated with a given file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile id

Box.getFileSingleMetadata

Get the metadata instance for a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile id
scopeStringThe scope of the metadata object (global or enterprise_{enterprise_id})
templateStringThe key of the template. For example, the global scope has the properties template.

Box.createFileMetadata

Create a metadata instance for a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile id
scopeStringhe scope of the metadata object (global or enterprise_{enterprise_id})
templateStringThe key of the template. For example, the global scope has the properties template.
keyNameStringKey name
keyValueStringValue of key

Box.deleteFileMetadata

Delete the template instance on a file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile id
scopeStringThe scope of the metadata object (global or enterprise_{enterprise_id})
templateStringThe key of the template. For example, the global scope has the properties template.

Box.getFolderAllMetadata

Used to retrieve all metadata associated with a given folder

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder id

Box.getFolderSingleMetadata

Get the metadata instance for a folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder id
scopeStringThe scope of the metadata object (global or enterprise_{enterprise_id})
templateStringThe key of the template. For example, the global scope has the properties template.

Box.createFolderMetadata

Create a metadata instance for a folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder id
scopeStringhe scope of the metadata object (global or enterprise_{enterprise_id})
templateStringThe key of the template. For example, the global scope has the properties template.
keyNameStringKey name
keyValueStringValue of key

Box.deleteFolderMetadata

Delete the metadata instance for a folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFile id
scopeStringThe scope of the metadata object (global or enterprise_{enterprise_id})
templateStringThe key of the template. For example, the global scope has the properties template.

Box.inviteUser

Invite an existing user to join an Enterprise.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
enterpriseIdStringThe ID of the enterprise the user will be invited to
loginStringThe login of the user that will receive the invitation

Box.getEnterpriseUsers

Returns all of the users for the Enterprise. Only available to admin accounts or service accounts.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userTypeStringThe type of user to search for. One of all, external or managed. The default is managed
filterTermStringOnly return users whose name or login matches the filter_term. See notes below for details on the matching.
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.deleteUser

Delete a user.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringThe ID of the user
notifyBooleanWhether the destination user will receive email notification of the transfer
forceBooleanWhether the user should be deleted even if this user still own files

Box.updateUser

Update the information for a user.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringThe ID of the user
fieldsListComma-separated list of fields to include in the response
notifyBooleanWhether the destination user will receive email notification of the transfer
enterpriseStringSet this to null to roll the user out of the enterprise and make them a free user
nameStringThe name of this user
roleStringThe user’s enterprise role. Can be coadmin or user
languageStringThe language of the user.
isSyncEnabledBooleanWhether the user can use Box Sync
jobTitleStringThe user’s job title
phoneStringThe user’s phone number
addressStringThe user’s address
spaceAmountNumberThe user’s total available space amount in byte. A value of -1 grants unlimited storage.
canSeeManagedUsersStringWhether the user can see other enterprise users in its contact list
statusSelectactive, inactive, cannot_delete_edit, or cannot_delete_edit_upload

Box.createAppUser

Create a new app user in an enterprise. This method only works for service accounts.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
nameStringThe name of this user
isPlatformAccessOnlyBooleanThe name of this user
notifyBooleanWhether the destination user will receive email notification of the transfer
enterpriseStringSet this to null to roll the user out of the enterprise and make them a free user
languageStringThe language of the user.
jobTitleStringThe user’s job title
phoneStringThe user’s phone number
addressStringThe user’s address
spaceAmountNumberThe user’s total available space amount in byte. A value of -1 grants unlimited storage.
statusSelectactive, inactive, cannot_delete_edit, or cannot_delete_edit_upload

Box.createUser

Create a new managed user in an enterprise. This method only works for enterprise admins.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
loginStringThe email address the user uses to login
nameStringThe name of this user
roleStringThe user’s enterprise role. Can be coadmin or user
languageStringThe language of the user.
isSyncEnabledBooleanWhether the user can use Box Sync
jobTitleStringThe user’s job title
phoneStringThe user’s phone number
addressStringThe user’s address
spaceAmountNumberThe user’s total available space amount in byte. A value of -1 grants unlimited storage.
canSeeManagedUsersStringWhether the user can see other enterprise users in its contact list
statusSelectactive, inactive, cannot_delete_edit, or cannot_delete_edit_upload

Box.getSingleUser

Get information about a user in the enterprise. Requires enterprise administration authorization.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
userIdStringThe ID of the user

Box.deleteEmailAlias

Removes an email alias from a user.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
emailAliasIdStringThe ID of the email alias
userIdStringThe ID of the user

Box.createEmailAlias

Adds a new email alias to the given user’s account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
emailStringThe email address to add to the account as an alias
userIdStringThe ID of the user

Box.getMe

Get information about the user who is currently logged in (i.e. the user for whom this auth token was generated).

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListThe email address to add to the account as an alias

Box.getEmailAliases

Retrieves all email aliases for this user.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringThe ID of the user

Box.changeUserLogin

Used to convert one of the user’s confirmed email aliases into the user’s primary login.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringThe ID of the user
fieldsListThe email address to add to the account as an alias
loginStringThe email alias to become the primary email

Box.moveOwnedItems

Move all of the items owned by a user into a new folder in another user’s account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringThe ID of the user
folderIdStringMust be 0 (the user's root folder)
ownedByIdStringThe ID of the user who the folder will be transferred to
fieldsListThe email address to add to the account as an alias
notifyBooleanWhether the destination user should receive email notification of the transfer

Box.getGroup

Get information about a group.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupIdStringGroup ID
fieldsListThe email address to add to the account as an alias

Box.createGroup

Create a new group.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
nameStringThe name of the new group to be created
fieldsListThe email address to add to the account as an alias
provenanceStringTypically used to track the external source where the group is coming from. Retrieved through the fields parameter.
externalSyncIdentifierStringTypically used as a group identifier for groups coming from an external source. Retrieved through the fields parameter.
descriptionStringDescription of the group. Retrieved through the fields parameter.

Box.updateGroup

Update a group.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupIdStringGroup ID
fieldsListThe email address to add to the account as an alias
nameStringThe name of the new group to be created
provenanceStringTypically used to track the external source where the group is coming from. Retrieved through the fields parameter.
externalSyncIdentifierStringTypically used as a group identifier for groups coming from an external source. Retrieved through the fields parameter.
descriptionStringDescription of the group. Retrieved through the fields parameter.

Box.deleteGroup

Delete a group.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupIdStringGroup ID

Box.getEnterpriseGroups

Returns all of the groups for given enterprise. Must have permissions to see an enterprise's groups.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
nameStringOnly return groups whose name contains a word starting with the given string (case insensitive)
fieldsListThe email address to add to the account as an alias
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getMembership

Fetches a specific group membership entry.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupMembershipIdStringGroup membership id

Box.createMembership

Add a member to a group.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringThe ID of the user to add to the group
groupIdStringThe ID of the group to add the user into.
roleSelectThe role of the user in the group. Default is member option for admin
canRunReportsBooleanCan run reports
canInstantLoginBooleanCan instant login
canCreateAccountsBooleanCan create accounts
canEditAccountsBooleanCan edit accounts

Box.updateMembership

Fetches a specific group membership entry.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupMembershipIdStringMembership Id
roleSelectThe role of the user in the group. Default is member option for admin
canRunReportsBooleanCan run reports
canInstantLoginBooleanCan instant login
canCreateAccountsBooleanCan create accounts
canEditAccountsBooleanCan edit accounts

Box.deleteMembership

Delete a group membership.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupMembershipIdStringMembership Id

Box.getGroupMemberships

Returns all of the members for a given group if the requesting user has access.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupIdStringGroup id
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getUserMemberships

Returns all of the group memberships for a given user. Note this is only available to group admins. To retrieve group memberships for the user making the API request, use the users/me/memberships endpoint.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
userIdStringUser id
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getGroupCollaborations

Returns all of the group collaborations for a given group. Note this is only available to group admins.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
groupIdStringGroup id
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getCollaboration

Get information about a collaboration.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
collabIdStringCollaboration Id
fieldsListThe email address to add to the account as an alias

Box.createCollaboration

Create a new collaboration that grants a user or group access to a file or folder in a specific role.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListThe email address to add to the account as an alias
notifyBooleanDetermines if the user (or all the users in the group) will receive email notifications
itemTypeStringfile or folder
itemIdStringThe ID of the file or folder that access is granted to
accessibleByTypeStringuser or group
accessibleByIdStringThe ID of the user or group that is granted access
accessibleByLoginStringThe email address of the person to grant access to. Use instead of id to invite new users
roleSelectThe level of access granted.
canViewPathBooleanWhether view path collaboration feature is enabled or not. View path collaborations allow the invitee to see the entire ancestral path to the associated folder. The user will not gain privileges in any ancestral folder (e.g. see content the user is not collaborated on).

Box.updateCollaboration

Update a collaboration.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
collabIdStringCollaboration Id
fieldsListThe email address to add to the account as an alias
roleSelectThe level of access granted. Can be editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner, or owner
statusStringThe status of the collaboration invitation. Can be accepted, pending, or rejected.
canViewPathBooleanWhether view path collaboration feature is enabled or not. View path collaborations allow the invitee to see the entire ancestral path to the associated folder. The user will not gain privileges in any ancestral folder (e.g. see content the user is not collaborated on).

Box.deleteCollaboration

Delete a collaboration.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
collabIdStringCollaboration Id

Box.getPendingCollaborations

Get all pending collaboration invites for a user.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.getSingleComment

Get information about a comment.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
commentIdStringComment Id

Box.createComment

Create a new comment.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
itemTypeStringThe type of the item that this comment will be placed on. Can be file or comment
itemIdStringThe ID of the item that this comment will be placed on
messageStringThe text of the comment
taggedMessageStringThe text of the comment, including @[userid:Username] somewhere in the message to mention the user, which will send them a direct email, letting them know they’ve been mentioned in a comment

Box.updateComment

Update a comment.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
commentIdStringThe ID of the comment
messageStringThe text of the comment

Box.deleteComment

Delete a comment.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
commentIdStringThe ID of the comment

Box.getWeblink

Get information about a web link.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
webLinkIdStringThe ID of the web link

Box.createWebLink

Create a new web link.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
urlStringThe URL the web link points to. Must start with http:// or https://.
parentIdStringThe ID of the parent folder where you're creating the web link
nameStringName of the web link. Defaults to the URL if not set.
descriptionStringDescription of the web link

Box.updateWebLink

Update a web link.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
webLinkIdStringThe ID of the web link
urlStringThe UR the web link points to. Must start with http:// or https://.
parentIdStringThe ID of the parent folder where you're creating the web link
nameStringName of the web link. Defaults to the URL if not set.
descriptionStringDescription of the web link

Box.deleteWebLink

Move a web link to the trash.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
webLinkIdStringThe ID of the web link

Box.getUserEvents

Get events for a given user. A chunk of event objects is returned for the user based on the parameters passed in. Parameters indicating how many chunks are left as well as the next stream_position are also returned.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
streamPositionStringThe location in the event stream from which you want to start receiving events. You can specify the special value now to get 0 events and the latest stream_position value. Specifying 0 will return all available events.
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 500.

Box.getEnterpriseEvents

Retrieves up to a year' events for all users in an enterprise. Upper and lower bounds as well as filters can be applied to the results.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
eventTypeListList of event types. Only matching events are returned.
streamPositionStringThe location in the event stream from which you want to start receiving events. You can specify the special value now to get 0 events and the latest stream_position value. Specifying 0 will return all available events.
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 500.

Box.getWatermarkOnFile

Used to retrieve the watermark for a corresponding Box file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile ID

Box.applyWatermarkOnFile

Used to apply or update the watermark for a corresponding Box file. The endpoint accepts a JSON body describing the watermark to apply.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile ID

Box.removeWatermarkOnFile

Used to remove the watermark for a corresponding Box file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringFile ID

Box.getWatermarkOnFolder

Used to retrieve the watermark for a corresponding Box folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder ID

Box.applyWatermarkOnFolder

Used to apply or update the watermark for a corresponding Box folder. The endpoints accepts a JSON body describing the watermark to apply.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder ID

Box.removeWatermarkOnFolder

Used to remove the watermark for a corresponding Box folder.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolder ID

Box.getDevicePin

Gets information about an individual device pin.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
devicePinIdStringDevice pin ID

Box.deleteDevicePin

Delete individual device pin

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
devicePinIdStringDevice pin ID

Box.getEnterpriseDevicePins

Gets all the device pins within a given enterprise. Must be an enterprise admin with the manage enterprise scope to make this call.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
enterpriseIdStringEnterprise ID
limitStringThe maximum number of items to return. The default is 100 and the maximum is 10,000.
directionStringThe sorting direction (by id). One of ASC or DESC (default is ASC). Case-insensitive.

Box.getCollections

Retrieves the collections for the given user. Only the Favorites collection is supported.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.

Box.getCollectionItems

Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder’s items.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
collectionIdStringCollection Id.
fieldsListComma-separated list of fields to include in the response
offsetNumberThe offset of the item at which to begin the response. See offset-based paging for details. https://developer.box.com/reference#offset-based-paging
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.

Box.addItemsToCollection

Add items from a Collection

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
collectionIdStringCollection Id.
folderIdStringFolderId

Box.deleteItemsFromCollection

Remove items from a Collection

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
folderIdStringFolderId

Box.getTask

Fetches a specific task.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskIdStringTask Id

Box.createTask

Used to create a single task for single user on a single file.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringThe ID of the file this task is associated with
messageStringAn optional message to include with the task
dueAtDatePickerWhen this task is due. Example: 2014-04-03T11:09:43-07:00

Box.updateTask

Updates a specific task.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskIdStringTask Id
messageStringAn optional message to include with the task
dueAtDatePickerWhen this task is due. Example: 2014-04-03T11:09:43-07:00

Box.deleteTask

Permanently deletes a specific task.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskIdStringTask Id

Box.getTaskAssignment

Fetches a specific task assignment.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskAssignmentIdStringTask Assignment Id

Box.createTaskAssignment

Used to assign a task to a single user. There can be multiple assignments on a given task.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskIdStringTask Id
assignToIdStringThe ID of the user this assignment is for
assignToLoginStringThe login email address for the user this assignment is for

Box.updateTaskAssignment

Used to update a task assignment

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskAssignmentIdStringTask Assignment Id
messageStringA message from the assignee about this task
resolutionStateSelectCan be completed, incomplete, approved, or rejected

Box.deleteTaskAssignment

Deletes a specific task assignment.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskAssignmentIdStringTask Assignment Id

Box.getTaskAssignments

Retrieves all of the assignments for a given task.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
taskIdStringTask Id

Box.getSingleRetentionPolicy

Used to retrieve information about a retention policy.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringPolicy Id

Box.createRetentionPolicy

Used to create a new retention policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyNameStringName of retention policy to be created
policyTypeSelectfinite or indefinite
retentionLengthNumberThe retention_length is the amount of time, in days, to apply the retention policy to the selected content in days. Do not specify for indefinite policies. Required for finite policies.
dispositionActionNumberIf creating a finite policy, the disposition action can be permanently_delete or remove_retention. For indefinite policies, disposition action must be remove_retention.

Box.updateRetentionPolicy

Used to update a retention policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringPolicy Id
policyNameStringUpdated name of retention policy
dispositionActionNumberIf creating a finite policy, the disposition action can be permanently_delete or remove_retention. For indefinite policies, disposition action must be remove_retention.
statusStringUsed to retire a retention policy if status is set to retired. If not retiring a policy, do not include or set to null.

Box.getRetentionPolicies

Retrieves all of the retention policies for the given enterprise. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyNameStringA name to filter the retention policies by. A trailing partial match search is performed.
policyTypeStringA policy type to filter the retention policies by.
createdByUserIdStringA user ID to filter the retention policies by.

Box.getRetentionPolicyAssignment

Used to retrieve information about a retention policy assignment. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
retentionPolicyAssignmentIdStringRetention Policy Assignment Id

Box.createRetentionPolicyAssignment

Used to retrieve information about a retention policy assignment. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringThe ID of the retention policy to assign this content to.
assignToTypeStringCan only be one of two attributes: enterprise or folder.
assignToIdStringId of the content to assign the retention policy to

Box.getSingleRetentionPolicyAssignments

Returns a list of all retention policy assignments associated with a specified retention policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringThe ID of the retention policy to assign this content to.
typeStringThe type of the retention policy assignment to retrieve. Can either be folder or enterprise.

Box.getSingleFileVersionRetention

Used to retrieve information about a file version retention. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileVersionRetentionIdStringFile version retention Id

Box.getFileVersionRetentions

Retrieves all file version retentions for the given enterprise. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
fileIdStringA file ID to filter the file version retentions by
fileVersionIdStringA file version ID to filter the file version retentions by
policyIdStringA policy ID to filter the file version retentions by
dispositionActionStringThe disposition action of the retention policy. This action can be permanently_delete, which will cause the content retained by the policy to be permanently deleted, or remove_retention, which will lift the retention policy from the content, allowing it to be deleted by users, once the retention policy time period has passed.
dispositionBeforeStringSee content times for formatting
dispositionAfterStringSee content times for formatting
limitNumberThe maximum number of items to return. The default is 100.
markerStringBase 64 encoded string that represents where the paging should being. It should be left blank to begin paging.

Box.getSingleLegalHoldPolicy

Get information about a legal hold policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringPolicy Id

Box.createLegalHoldPolicy

Create a new legal hold policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyNameStringName of Legal Hold Policy. Max characters 254.
descriptionStringDescription of Legal Hold Policy. Max characters 500.
filterStartedAtStringDate filter applies to Custodian assignments only.
filterEndedAtStringDate filter applies to Custodian assignments only.
isOngoingBooleanAfter initialization, Assignments under this Policy will continue applying to files based on events, indefinitely.

Box.updateLegalHoldPolicy

Update a legal hold policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringPolicy Id
policyNameStringName of Legal Hold Policy. Max characters 254.
descriptionStringDescription of Legal Hold Policy. Max characters 500.
releaseNotesStringNotes around why the policy was released. Optional property with a 500 character limit.

Box.deleteLegalHoldPolicy

Sends a request to delete an existing legal hold policy. Note that this is an asynchronous process - the policy will not be fully deleted yet when the response comes back. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringPolicy Id

Box.getLegalHoldPolicies

Get all of the legal hold policies for the enterprise. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyNameStringCase insensitive prefix-match filter on Policy name.
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 1,000.
markerStringTake from 'next_marker' column of a prior call to get the next page

Box.getSinglePolicyAssignment

Get information about a policy assignment. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
assignmentIdStringAssignment Id

Box.createNewPolicyAssignment

Create a new policy assignment, which applies the legal hold policy to the target of the assignment. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringID of Policy to create Assignment for.
assignToIdSelectPossible values for id are file_version_id, file_id, folder_id, or user_id
assignToTypeSelectPossible values for type are file_version, file, folder, or user

Box.deletePolicyAssignment

Sends a request to delete an existing policy assignment. Note that this is an asynchronous process - the policy assignment will not be fully deleted yet when the response comes back. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
assignmentIdStringAssignment Id

Box.getPolicyAssignments

Get all of the assignments for a legal hold policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringID of Policy to get Assignments for. Can also specify a part of a URL
assignToTypeStringFilter assignments of this type only. Can be file_version, file, folder, or user.
assignToIdStringFilter assignments to this ID only. Note that this will only show assignments applied directly to this entity.

Box.getFileVersionSingleLegalHold

Get information about a file version legal hold. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
idStringID of File Version Legal Hold

Box.getFileVersionLegalHolds

Get all of the non-deleted legal holds for a single legal hold policy. Only Business Plus or Enterprise account.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
policyIdStringPolicy Id

Box.getWebhooks

Get all webhooks in an enterprise.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
markerStringThe position marker at which to begin the response. See marker-based paging for details.
limitNumberThe maximum number of items to return. The default is 100 and the maximum is 200.

Box.getSingleWebhook

Get information about a webhook.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
webhookIdStringWebhook Id

Box.createWebhook

Create a new webhook. You can use our service as webhookUrl: https://webhooks.rapidapi.com/api/message/Box/webhookCommand/{projectName}/{projectKey} * see credentials description above

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
targetTypeStringTarget type. file or folder
targetIdStringTarget Id
triggersStringEvent types that trigger notifications for the target. Example: FILE.UPLOADED,FILE.DOWNLOADED
addressStringThe notification URL of the webhook. The notification URL is the URL used by Box to send a notification when the webhook is triggered.

Box.updateWebhook

Update a webhook.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
webhookIdStringWebhook Id
targetTypeStringTarget type
targetIdStringTarget Id
triggersStringEvent types that trigger notifications for the target. Example:FILE.UPLOADED,FILE.DOWNLOADED
addressStringThe notification URL of the webhook. The notification URL is the URL used by Box to send a notification when the webhook is triggered.

Box.deleteWebhook

Delete a webhook.

FieldTypeDescription
accessTokenStringAccess token is a data string that enables Box to verify that a request belongs to an authorized session.
webhookIdStringWebhook Id
x
circle
Box
$ / m
We will charge your card every month for the plan amount, as well as any overages incurred in the previous month.
?

Oops, we are missing some details

Looks like there are a few missing details that you haven't filled in yet.
These details are important and will help us protect you and let you know about anything new.

x

Connect your app to APIs via RapidAPI

Consume and monitor multiple APIs through the RapidAPI SDK.
Click start to set up your app and connect to your first API.

START

Give your app a name

This app will be used in RapidAPI to collect and connect all the APIs you need.

NEXT

Connect your project

Choose your backend language and then install & require the RapidAPI SDK.

  • node
    NodeJS
  • php
    PHP
  • python
    Python
  • objc
    Obj-C
  • android
    Android
  • go
    GO
  • ruby
    Ruby
  • csharp
    C#

Install SDK

Run the following command to install the SDK:

npm install rapidapi-connect --save

Require SDK

In your code, add the following code to require the RapidAPI SDK:

NEXT

Hooray! You are connected

Use the following code to try it out by getting all the APIs that are on RapidAPI.

rapid.call('RapidAPI', 'getAll', {'{}'});
FINISH
esccloses this view
x

Login to RapidAPI

Create endpoints based on popular APIs and share with others.
Follow popular APIs and get updated. Stand out in the community of developers.

LOG INSIGN UP
Login with Github
Login with Facebook
Login with Google
Or
Remember Me

  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Why sign up to RapidAPI?

    • integrate
      Integrate APIs into your app
      Ruby, Java, Elixir, Node.js, Phyton, Objective C, Swift, PHP and MORE
    • keys
      Save all API keys in one place
    • notifications
      Get notifications about API changes
    • stats
      Get stats and monitor API connections
    Sign up with Github
    Sign up with Facebook
    Sign up with Google
  • We're not going to post anything on your wall.
  • We're not planning to spam you.
  • esccloses this view
    x

    Authentication

    Authenticate
    esccloses this view