Streamdata.io API Gallery - Box (Report Issue)

Organization(s):

Box Pending Collaborations

Used to retrieve all pending collaboration invites for this user.

Box Create Collaboration

Used to add a collaboration for a single user or a single group to a folder. Either an email address, a user ID, or a group id can be used to create the collaboration. If the collaboration is being created with a group, access to this endpoint is ...

Box Delete Collaboration

Used to delete a single collaboration.

Box Get Collaboration

Used to get information about a single collaboration. All collaborations for a single folder can be retrieved through GET /folders/{id}/collaborations. A complete list of the user???s pending collaborations can also be retrieved.

Box Update Collaboration

Used to edit an existing collaboration. Descriptions of the various roles can be found here.

Box Get Collections

Retrieves the collections for the given user. Currently, only the favorites collection is supported.

Box Get Collection Items

Retrieves the files and/or folders contained within this collection. Collection item lists behave a lot like getting a folder???s items. Paginated results can be retrieved using the limit and offset parameters. Sub-object fields can be requested v...

Box Create Comment

Used to add a comment by the user to a specific file or comment (i.e. as a reply comment).

Box Delete Comment

Permanently deletes a comment.

Box Get Comment

Used to retrieve the message and metadata about a specific comment. Information about the user who created the comment is also included.

Box Update Comment

Used to update the message of the comment.

Box Delete Device Pin

Delete individual device pin.

Box Get Device Pin

Gets information about an individual device pin.

Box Get Enterprise Device Pins

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

Box User Events, Enterprise Events

Use this to 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. To retrieve Enterp...

Box Long polling

To get real-time notification of activity in a Box account, use the long poll feature of the /events API. To do so, first call the /events API with an OPTIONS call to retrieve the long poll URL to use. Next, make a GET request to the provided URL ...

Box Get List of File Version Legal Holds

Get list of non-deleted Holds for a single Policy.

Box Get File Version Legal Hold

Get details of a single File Version Legal Hold.

Box Get File Version Retentions

Retrieves all file version retentions for the given enterprise.

Box Get File Version Retention

Used to retrieve information about a file version retention

Box File upload preflight check

The Pre-flight check API will verify that a file will be accepted by Box before you send all the bytes over the wire.

Box Delete File

Discards a file to the trash. The etag of the file can be included as an ???If-Match??? header to prevent race conditions.

Box Get File's Info, Get Embed Link

Used to retrieve the metadata about a file.

Box Restore Item

Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that paren...

Box Update File Info, Lock and Unlock, Create Shared Link

Used to update individual or multiple fields in the file object, including renaming the file, changing its description, and creating a shared link for the file. To move a file, change the ID of its parent folder. An optional If-Match header can be...

Box Get File's Collaborations

Use this to get a list of all the collaborations on a file

Box Get File's Comments

Retrieves the comments on a particular file, if any exist.

Box Download File

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

Box Copy File

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

Box Get all Metadata on File

Used to retrieve all metadata associated with a given file

Box Delete Metadata on File

Used to delete the template instance. To delete custom key:value pairs within a template instance, you should refer to the updating metadata section.

Box Get Metadata on File

Used to retrieve the metadata template instance for a corresponding Box file.

Box Create Metadata on File

Used to create the metadata template instance for a corresponding Box file. When creating metadata, only values that adhere to the metadata template schema will be accepted.

Box Update Metadata on File

Used to update the template instance. The request body must follow the JSON-Patch specification, which is represented as a JSON array of operation objects (see examples for more details). Updates can be either add, replace, remove , test, move, or...

Box Get File's Tasks

Retrieves all of the tasks for given file.

Box Get Thumbnail

Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg format. Thumbnails can ...

Box Get Thumbnail

Retrieves a thumbnail, or smaller image representation, of this file. Sizes of 32x32,64x64, 128x128, and 256x256 can be returned in the .png format and sizes of 32x32, 94x94, 160x160, and 320x320 can be returned in the .jpg format. Thumbnails can ...

Box Permanently Delete

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

Box Get Trashed File

Retrieves an item that has been moved to the trash.

Box View Versions

If there are previous versions of this file, this method can be used to retrieve information about the older versions. (Versions are only tracked for Box users with premium accounts.)

Box Promote Version

If there are previous versions of this file, this method can be used to promote one of the older versions to the top of the stack. This actually mints a copy of the old version and puts it on the top of the versions stack. The file will have the e...

Box Delete Old Version

Discards a specific file version to the trash. (Depending on the enterprise settings for this user, the item will either be actually deleted from Box or moved to the trash.)

Box Remove Watermark on File

Used to remove the watermark for a corresponding Box file.

Box Get Watermark on File

Used to retrieve the watermark for a corresponding Box file.

Box Apply Watermark on File

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

Box Create Folder

Used to create a new empty folder. The new folder will be created inside of the specified parent folder

Box Delete Folder

Used to delete a folder. A recursive parameter must be included in order to delete folders that have items inside of them. An optional If-Match header can be included to ensure that client only deletes the folder if it knows about the latest version.

Box Get Folder's Info

Retrieves the full metadata about a folder, including information about when it was last updated as well as the files and folders contained in it. The root folder of a Box account is always represented by the id ???0???.

Box Restore Folder

Restores an item that has been moved to the trash. Default behavior is to restore the item to the folder it was in before it was moved to the trash. If that parent folder no longer exists or if there is now an item with the same name in that paren...

Box Update Folder, Create Shared Link, Create or Delete

Used to update information about the folder. To move a folder, update the ID of its parent. To enable an email address that can be used to upload files to this folder, update the folder_upload_email attribute. An optional If-Match header can be in...

Box Get Folder Collaborations

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.

Box Copy Folder

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

Box Get Folder???s Items

Retrieves the files and/or folders contained within this folder without any other metadata about the folder. Any attribute in the full files or folders objects can be passed in with the fields parameter to get specific attributes, and only those s...

Box Get All Metadata on Folder

Used to retrieve all metadata associated with a given folder

Box Delete Metadata on Folder

Used to delete the template instance. To delete custom key:value pairs within a template instance, you should refer to the updating metadata section.

Box Get Metadata on Folder

Used to retrieve the metadata template instance for a corresponding Box folder.

Box Create Metadata on Folder

Used to create the metadata template instance for a corresponding Box folder. When creating metadata, only values that adhere to the metadata template schema will be accepted.

Box Update Metadata on Folder

Used to update the template instance. Updates can be either add, replace, remove , or test. The template instance can only be updated if the template instance already exists. When editing metadata, only values that adhere to the metadata template ...

Box Permanently Delete

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

Box Get Trashed Folder

Retrieves an folder that has been moved to the trash.

Box Remove Watermark on Folder

Used to remove the watermark for a corresponding Box Folder.

Box Get Watermark on Folder

Used to retrieve the watermark for a corresponding Box folder.

Box Apply Watermark on Folder

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

Box Get Trashed Items

Retrieves the files and/or 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 get specific attributes, and only those specific attributes back; otherwise, the...

Box Create Membership

Used to add a member to a Group.

Box Delete Membership

Deletes a specific group membership.

Box Get Membership

Fetches a specific group membership entry.

Box Update Membership

Used to update a group membership.

Box Get Groups for an Enterprise

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

Box Create Group

Used to create a group.

Box Delete Group

Permanently deletes a specific group.

Box Get Group

Used to get information about a group.

Box Update Group

Updates a specific group.

Box Get Collaborations for Group

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

Box Get Memberships for Group

Retrieves all of the members for a given group if the requesting user has access (see Group Object member_viewability_level).

Box Invite User

Invites an existing 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 prompt to accept the invitation within the Box web applic...

Box Get Legal Hold Policies

Get a list of Legal Hold Policies that belong to your Enterprise.

Box Create New Legal Hold Policy

Create a new Legal Hold Policy. Optional date filter may be passed. If Policy has a date filter, any Custodian assignments will apply only to file versions created or uploaded inside of the date range.

Box Delete Legal Hold Policy

Sends 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.

Box Get Legal Hold Policy

Get details of a single Legal Hold Policy

Box Update Existing Legal Hold Policy

Update existing Legal Hold Policy. Only name and description can be modified.

Box Get Legal hold policy assignments

Get list of assignments for a single Policy.

Box Create New Legal Hold Policy Assignment

Create a new Assignment, which will apply the Legal Hold Policy to the target of the Assignment.

Box Delete Legal Hold Policy Assignment

Sends request to delete an existing Assignment. Note that this is an asynchronous process - the Assignment will not be fully deleted yet when the response comes back.

Box Get Legal Hold Policy Assignment

Get details of a single assignment.

Box Create Metadata Template

Used to create a new metadata template with the specified schema.

Box Get Enterprise Metadata

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

Box Get Metadata Template

Used to retrieve the schema for a given metadata template.

Box Update Metadata Template

Used to update the schema of an existing template.

Box Get Retention Policies

Retrieves all of the retention policies for the given enterprise.

Box Create Retention Policy

Used to create a new retention policy.

Box Get Retention Policy

Used to retrieve information about a retention policy

Box Update Retention Policy

Used to update a retention policy.

Box Get Retention Policy Assignments

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

Box Create Retention Policy Assignment

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

Box Get Retention Policy Assignment

Used to retrieve information about a retention policy assignment.

Box Searching for Content

The search endpoint provides a powerful way of finding items that are accessible by a single user or an entire enterprise. Leverage the parameters listed below to generate targeted advanced searches.

Box Shared Items

Shared items are any files or folders that are represented by a shared link. Shared items are different from other API resources in that a shared resource doesn???t necessarily have to be in the account of the user accessing it. The actual shared ...

Box Create Task Assignment

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

Box Delete Task Assignment

Deletes a specific task assignment.

Box Get Task Assignment

Fetches a specific task assignment.

Box Update Task Assignment

Used to update a task assignment.

Box Create Task

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

Box Delete Task

Permanently deletes a specific task.

Box Get Task

Fetches a specific task.

Box Update Task

Updates a specific task.

Box Get Assignments

Retrieves all of the assignments for a given task.

Box Get Enterprise Users

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

Box Create User

Used to provision a new user in an enterprise. This method only works for enterprise admins.

Box Get Current User

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

Box Delete User

Deletes a user in an enterprise account.

Box Get User's Info

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

Box Update User, Change User's Login

Used to edit the settings and information about a user. This method only works for enterprise admins. To roll a user out of the enterprise (and convert them to a standalone free user), update the special enterprise attribute to be null. Used to c...

Box Get Email Aliases

Retrieves all email aliases for this user. The collection of email aliases does not include the primary login for the user; use GET /users/USER_ID to retrieve the login email address.

Box Add Email Alias

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

Box Delete Email Alias

Removes an email alias from a user.

Box Move User's Folder

Moves all of the owned content from within one user???s folder into a new folder in another user???s account. You can move folders across users as long as the you have administrative permissions and the ???source??? user owns the folders. To move ...

Box Get Memberships for User

Retrieves 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.

Box Create Web Link

Creates a web link object within a given folder.

Box Delete Web Link

Deletes a web link and moves it to the trash

Box Get Web Link

Use to get information about the web link.

Box Update Web Link

Updates information for a web link.

Box Get Webhooks

Returns all defined webhooks for the requesting application and user, up to the limit. If no limit is supplied then Box uses the default limit of 100. If more than limit webhooks are defined then Box returns the webhooks in batches. When the resul...

Box Create Webhook

Create Webhook

Box Delete Webhook

Permanently deletes a webhook

Box Get Webhook

Get a Webhook

Box Update Webhook

Update a Webhook

Submit Your API

Join the gallery to find out how much you can save with Streamdata.io.