Box

Learn how to use Box with Composio

Overview

SLUG

BOX

Description

Cloud content management and file sharing service for businesses.

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
string
full
stringDefaults to https://api.box.com/2.0
bearer_token
string

Tools

SLUG: BOX_CREATE_BOX_SIGN_REQUEST

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

Action Parameters

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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`.

Action Parameters

accessible__by__id
string
accessible__by__login
string
accessible__by__type
string
can_view_path
boolean
expires_at
string
fields
array
is_access_only
boolean
item__id
string
item__type
string
notify
boolean
role
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_CREATE_COMMENT

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

Action Parameters

fields
array
item__id
string
item__type
string
message
stringRequired
tagged_message
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_CREATE_FOLDER

Creates a new empty folder within the specified parent folder.

Action Parameters

fields
array
name
stringRequired
parent__id
string
sync_state
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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.

Action Parameters

file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_DOWNLOAD_FILE

Returns the contents of a file in binary format.

Action Parameters

access_token
string
file_id
stringRequired
version
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_GET_FILE_INFORMATION

Retrieves the details about a file.

Action Parameters

fields
array
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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](r://folder--full#param-item-collection). to fetch more items within the folder, use the [get items in a folder](e://get-folders-id-items) endpoint.

Action Parameters

direction
string
fields
array
folder_id
stringRequired
limit
integer
offset
integer
sort
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_LIST_FILE_COMMENTS

Retrieves a list of comments for a file.

Action Parameters

fields
array
file_id
stringRequired
limit
integer
offset
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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](#get-folders-id) endpoint instead.

Action Parameters

direction
string
fields
array
folder_id
stringRequired
limit
integer
marker
string
offset
integer
sort
string
usemarker
boolean

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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](#get-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.

Action Parameters

actor_token
string
actor_token_type
string
assertion
string
box_shared_link
string
box_subject_id
string
box_subject_type
string
client_id
string
client_secret
string
code
string
grant_type
stringRequired
refresh_token
string
resource
string
scope
string
subject_token
string
subject_token_type
string

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_SEARCH_FOR_CONTENT

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

Action Parameters

ancestor_folder_ids
array
content_types
array
created_at_range
array
deleted_at_range
array
deleted_user_ids
array
direction
stringDefaults to DESC
fields
array
file_extensions
array
include_recent_shared_links
boolean
limit
integerDefaults to 30
mdfilters
array
offset
integer
owner_user_ids
array
query
string
recent_updater_user_ids
array
scope
stringDefaults to user_content
size_range
array
sort
stringDefaults to relevance
trash_content
stringDefaults to non_trashed_only
type
string
updated_at_range
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_UPDATE_FILE

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

Action Parameters

collections
array
description
string
disposition_at
string
fields
array
file_id
stringRequired
lock__access
string
lock__expires__at
string
lock__is__download__prevented
boolean
name
string
permissions__can__download
string
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_UPDATE_FOLDER

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

Action Parameters

can_non_owners_invite
boolean
can_non_owners_view_collaborators
boolean
collections
array
description
string
fields
array
folder_id
stringRequired
is_collaboration_restricted_to_enterprise
boolean
name
string
sync_state
string
tags
array

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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`.

Action Parameters

Box__Security__Classification__Key
string
file_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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`.

Action Parameters

Box__Security__Classification__Key
string
folder_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_ADD_DOMAIN_TO_LIST_OF_ALLOWED_COLLABORATION_DOMAINS

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

Action Parameters

direction
stringRequired
domain
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_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.

Action Parameters

copyInstanceOnItemCopy
boolean
displayName
stringRequired
fields
arrayRequired
hidden
boolean
scope
stringRequired
templateKey
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

SLUG: BOX_ADD_OR_UPDATE_USER_AVATAR

Adds or updates a user avatar.

Action Parameters

pic
object
user_id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired