Box

The Box connector facilitates seamless integration with Box services, enabling automated file and content management operations.

Box is a cloud content management and file sharing service for businesses, offering secure access to files from anywhere. The Box connector for Swimlane Turbine enables users to automate content workflows, manage file uploads, and collaborate with ease. By integrating with Box, Swimlane Turbine users can streamline data exchange, enhance security operations, and leverage Box's robust file management capabilities directly within their security automation playbooks. This connector facilitates seamless interactions with Box's API, allowing for efficient file handling, metadata queries, and collaboration management without the need for manual intervention.

The Box API to interact with various aspects of the Box content collaboration product. This connector focuses on APIs related to files, collaborations, users, events, folders, shared links, search, workflow, groups, and upload.

Prerequisites

To effectively utilize the Box connector with Swimlane Turbine, ensure you have the following prerequisites:

OAuth 2.0 authentication with these parameters:

URL: The endpoint URL for Box API services.

Access Token: A valid OAuth 2.0 access token for authorization.

Custom authentication with these parameters:

URL: The endpoint URL for Box API services.

Client ID: The unique identifier for your Box application.

Client Secret: The secret key associated with your Box application's Client ID.

Grant Type: The type of OAuth grant used for obtaining the access token.

Note

Link to Authentication

Link to Authentication using Oauth2.0

The Swimlane team will provide a Python script and instructions on how to use the script to generate the Access Token using Oauth2.0

Capabilities

This Connector provides the following capabilities:

Commit upload session

Create upload session for existing file

Create upload session

Get Collaborations

Get Events

Get File from Shared Link

Get File

Get Folder for Shared Link

Get Group

Get List Items in Folder

Get List parts

Get Metadata Query

Get upload session

Get User

Get Workflows ... and so on

Note

Interact with Files: API Reference

Manage Collaborations: API Reference

Manage Users: API Reference

Handle Events: API Reference

Manage Folders: API Reference

Handle Shared Links (Folders): API Reference

Handle Shared Links (Files): API Reference

Execute Search: API Reference

Handle Workflow: API Reference

Manage Groups: API Reference

Handle Uploads: API Reference

Handle Chunked Uploads: API Reference

Upload File Version: API Reference

Configurations

Box Authentication using Oauth2.0

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
access_token	The Access token	string	Required
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Box Authentication

Configuration Parameters

Parameter	Description	Type	Required
url	A URL to the target host.	string	Required
client_id	The client ID	string	Required
client_secret	The client secret.	string	Required
actor_token	The actor token	string	Optional
actor_token_type	The Actor token type	string	Optional
assertion	The assertion	string	Optional
box_shared_link	The box shared link	string	Optional
box_subject_id	The box subject ID	string	Optional
box_subject_type	The box subject type	string	Optional
code	The code	string	Optional
grant_type	The grant type	string	Required
refresh_token	The refresh token	string	Optional
resource	The resource	string	Optional
scope	The scope	string	Optional
subject_token	The subject token	string	Optional
subject_token_type	The subject token type	string	Optional
verify_ssl	Verify SSL certificate	boolean	Optional
http_proxy	A proxy to route requests through.	string	Optional

Actions

Commit upload session

Finalizes an active upload session and creates a file from the parts in Box using the specified 'upload_session_id'.

Endpoint

URL: /files/upload_sessions/{{upload_session_id}}/commit

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.upload_session_id	string	Required	Parameters for the Commit upload session action
headers	object	Required	HTTP headers for the request
headers.digest	string	Required	HTTP headers for the request
headers.if-match	string	Optional	HTTP headers for the request
headers.if-none-match	string	Optional	HTTP headers for the request
parts	array	Optional	Parameter for Commit upload session
parts.part_id	string	Required	Unique identifier
parts.offset	number	Required	Parameter for Commit upload session
parts.size	number	Required	Parameter for Commit upload session
parts.sha1	string	Required	Parameter for Commit upload session

Input Example

{"json_body":{"parts":[{"part_id":"BFDF5379","offset":0,"size":8388608,"sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc"}]},"path_parameters":{"upload_session_id":"D5E3F7A"},"headers":{"digest":"sha=fpRyg5eVQletdZqEKaFlqwBXJzM=","if-match":"1","if-none-match":"1"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
entries	array	Output field: entries
entries.id	string	Unique identifier
entries.etag	string	Output field: entries.etag
entries.type	string	Type of the resource
entries.sequence_id	string	Unique identifier
entries.name	string	Name of the resource
entries.sha1	string	Output field: entries.sha1
entries.file_version	object	Output field: entries.file_version
entries.file_version.id	string	Unique identifier
entries.file_version.type	string	Type of the resource
entries.file_version.sha1	string	Output field: entries.file_version.sha1
entries.description	string	Output field: entries.description
entries.size	number	Output field: entries.size
entries.path_collection	object	Output field: entries.path_collection
entries.path_collection.total_count	number	Count value
entries.path_collection.entries	array	Output field: entries.path_collection.entries
entries.path_collection.entries.id	string	Unique identifier
entries.path_collection.entries.etag	string	Output field: entries.path_collection.entries.etag
entries.path_collection.entries.type	string	Type of the resource
entries.path_collection.entries.sequence_id	string	Unique identifier
entries.path_collection.entries.name	string	Name of the resource

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"entries":[{}]}}

Create upload session

Initiates an upload session in Box for a new file, specifying the file's name, size, and target folder ID.

Endpoint

URL: /files/upload_sessions

Method: POST

Input

Argument Name	Type	Required	Description
file_name	string	Optional	Name of the resource
file_size	number	Optional	Parameter for Create upload session
folder_id	string	Optional	Unique identifier

Input Example

{"json_body":{"file_name":"Project.mov","file_size":104857600,"folder_id":"0"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
num_parts_processed	number	Output field: num_parts_processed
part_size	number	Output field: part_size
session_endpoints	object	Output field: session_endpoints
session_endpoints.abort	string	Output field: session_endpoints.abort
session_endpoints.commit	string	Output field: session_endpoints.commit
session_endpoints.list_parts	string	Output field: session_endpoints.list_parts
session_endpoints.log_event	string	Output field: session_endpoints.log_event
session_endpoints.status	string	Status value
session_endpoints.upload_part	string	Output field: session_endpoints.upload_part
session_expires_at	string	Output field: session_expires_at
total_parts	number	Output field: total_parts

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"F971964745A5CD0C001BBE4E58196BFD","type":"upload_session","num_parts_processed":455,"part_size":1024,"session_endpoints":{"abort":"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E581...","commit":"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E581...","list_parts":"https://upload.box.com/api/2.0/files/upload_sessions/F971964745A5CD0C001BBE4E581...","log_event":"htt...

Create upload session for existing file

Initiates an upload session for an existing file on Box using the file's ID and size.

Endpoint

URL: /files/{{file_id}}/upload_sessions

Method: POST

Input

Argument Name	Type	Required	Description
path_parameters.file_id	string	Required	Parameters for the Create upload session for existing file action
file_name	string	Optional	Name of the resource
file_size	number	Optional	Parameter for Create upload session for existing file

Input Example

{"json_body":{"file_name":"Project.mov","file_size":104857600},"path_parameters":{"file_id":"1234"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
num_parts_processed	number	Output field: num_parts_processed
part_size	number	Output field: part_size
session_endpoints	object	Output field: session_endpoints
session_endpoints.abort	string	Output field: session_endpoints.abort
session_endpoints.commit	string	Output field: session_endpoints.commit
session_endpoints.list_parts	string	Output field: session_endpoints.list_parts
session_endpoints.log_event	string	Output field: session_endpoints.log_event
session_endpoints.status	string	Status value
session_endpoints.upload_part	string	Output field: session_endpoints.upload_part
session_expires_at	string	Output field: session_expires_at
total_parts	number	Output field: total_parts

Output Example

Get Collaborations

Retrieves details for a specific collaboration in Box using the provided collaboration ID.

Endpoint

URL: /collaborations/{{collaboration_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.collaboration_id	string	Required	Parameters for the Get Collaborations action
parameters.fields	array	Optional	Parameters for the Get Collaborations action
parameters.fields.id	string	Optional	Parameters for the Get Collaborations action
parameters.fields.type	string	Optional	Parameters for the Get Collaborations action
parameters.fields.name	string	Optional	Parameters for the Get Collaborations action

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"user","name":"Aaron Levie"}]},"path_parameters":{"collaboration_id":"1234"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
acceptance_requirements_status	object	Status value
acceptance_requirements_status.strong_password_requirement	object	Status value
acceptance_requirements_status.strong_password_requirement.enterprise_has_strong_password_required_for_external_users	boolean	Status value
acceptance_requirements_status.strong_password_requirement.user_has_strong_password	boolean	Status value
acceptance_requirements_status.terms_of_service_requirement	object	Status value
acceptance_requirements_status.terms_of_service_requirement.is_accepted	boolean	Status value
acceptance_requirements_status.terms_of_service_requirement.terms_of_service	object	Status value
acceptance_requirements_status.terms_of_service_requirement.terms_of_service.id	string	Unique identifier
acceptance_requirements_status.terms_of_service_requirement.terms_of_service.type	string	Type of the resource
acceptance_requirements_status.two_factor_authentication_requirement	object	Status value
acceptance_requirements_status.two_factor_authentication_requirement.enterprise_has_two_factor_auth_enabled	boolean	Status value
acceptance_requirements_status.two_factor_authentication_requirement.user_has_two_factor_authentication_enabled	boolean	Status value
accessible_by	object	Output field: accessible_by
accessible_by.id	string	Unique identifier
accessible_by.type	string	Type of the resource
accessible_by.login	string	Output field: accessible_by.login
accessible_by.name	string	Name of the resource
acknowledged_at	string	Output field: acknowledged_at
created_at	string	Output field: created_at
created_by	array	Output field: created_by
created_by.id	number	Unique identifier

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"12345678","type":"collaboration","acceptance_requirements_status":{"strong_password_requirement":{},"terms_of_service_requirement":{},"two_factor_authentication_requirement":{}},"accessible_by":{"id":"11446498","type":"user","login":"[email protected]","name":"Aaron Levie"},"acknowledged_at":"2012-12-12T10:55:20-08:00","created_at":"2012-12-12T10:53:43-08:00","created_by":[{"id":33224412},{"type":"user"},{"login":"dylan@exam...

Get Events

Retrieves past events for a user or the entire enterprise on Box, with a history span of up to one year.

Endpoint

URL: /events

Method: GET

Input

Argument Name	Type	Required	Description
parameters.created_after	string	Optional	Parameters for the Get Events action
parameters.created_before	string	Optional	Parameters for the Get Events action
parameters.event_type	string	Optional	Parameters for the Get Events action
parameters.limit	number	Optional	Parameters for the Get Events action
parameters.stream_position	string	Optional	Parameters for the Get Events action
parameters.stream_type	string	Optional	Parameters for the Get Events action

Input Example

{"parameters":{"created_after":"2012-12-12T10:53:43-08:00","created_before":"2013-12-12T10:53:43-08:00","event_type":"ACCESS_GRANTED","limit":50,"stream_position":"1348790499819","stream_type":"all"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
chunk_size	number	Output field: chunk_size
entries	array	Output field: entries
entries.type	string	Type of the resource
entries.created_at	string	Output field: entries.created_at
entries.recorded_at	string	Output field: entries.recorded_at
entries.event_id	string	Unique identifier
entries.created_by	object	Output field: entries.created_by
entries.created_by.id	string	Unique identifier
entries.created_by.type	string	Type of the resource
entries.created_by.name	string	Name of the resource
entries.created_by.login	string	Output field: entries.created_by.login
entries.event_type	string	Type of the resource
entries.session_id	string	Unique identifier
entries.source	object	Output field: entries.source
entries.source.id	string	Unique identifier
entries.source.type	string	Type of the resource
entries.source.name	string	Name of the resource
entries.source.login	string	Output field: entries.source.login
entries.source.created_at	string	Output field: entries.source.created_at
entries.source.modified_at	string	Output field: entries.source.modified_at
entries.source.language	string	Output field: entries.source.language
entries.source.timezone	string	Output field: entries.source.timezone
entries.source.space_amount	number	Output field: entries.source.space_amount

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"chunk_size":2,"entries":[{}],"next_stream_position":"1152922976252290886"}}

Get File

Retrieves a specific file's details from Box using the given file ID.

Endpoint

URL: /files/{{file_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.file_id	string	Required	Parameters for the Get File action
parameters.fields	array	Optional	Parameters for the Get File action
parameters.fields.id	string	Optional	Parameters for the Get File action
parameters.fields.type	string	Optional	Parameters for the Get File action
parameters.fields.name	string	Optional	Parameters for the Get File action
headers	object	Optional	HTTP headers for the request
headers.boxapi	string	Optional	HTTP headers for the request
headers.if-none-match	string	Optional	HTTP headers for the request
headers.x-rep-hints	string	Optional	HTTP headers for the request

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"user","name":"Aaron Levie"}]},"path_parameters":{"file_id":"12345"},"headers":{"boxapi":"shared_link=[link]&shared_link_password=[password]","if-none-match":"1","x-rep-hints":"[jpg?dimensions=32x32][jpg?dimensions=64x64]"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
has_collaborations	boolean	Output field: has_collaborations
is_accessible_via_shared_link	boolean	Output field: is_accessible_via_shared_link
is_externally_owned	boolean	Output field: is_externally_owned
is_package	boolean	Output field: is_package
item_status	string	Status value
lock	object	Output field: lock
lock.id	string	Unique identifier
lock.type	string	Type of the resource
lock.app_type	string	Type of the resource
lock.created_at	string	Output field: lock.created_at
lock.created_by	object	Output field: lock.created_by
lock.created_by.id	string	Unique identifier
lock.created_by.type	string	Type of the resource
lock.created_by.login	string	Output field: lock.created_by.login
lock.created_by.name	string	Name of the resource
lock.expired_at	string	Output field: lock.expired_at
lock.is_download_prevented	boolean	Output field: lock.is_download_prevented
id	string	Unique identifier
type	string	Type of the resource
allowed_invitee_roles	array	Output field: allowed_invitee_roles
token_type	string	Type of the resource
url	string	URL endpoint for the request

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"12345","type":"file","allowed_invitee_roles":["editor"],"token_type":"bearer","url":"https://cloud.app.box.com/preview/expiring_embed/..."},"has_collaborations":true,"is_accessible_via_shared_link":true,"is_externally_owned":true,"is_package":true,"item_status":"active","lock":{"id":"11446498","type":"lock","app_type":"office_wopiplus","created_at":"2012-12-12T10:53:43-08:00","created_by":{"id":"11446498","type":"user","lo...

Get File from Shared Link

Retrieves a file from Box via a shared link, with authorization headers needed for access.

Endpoint

URL: /shared_items

Method: GET

Input

Argument Name	Type	Required	Description
parameters.fields	array	Optional	Parameters for the Get File from Shared Link action
parameters.fields.id	string	Optional	Parameters for the Get File from Shared Link action
parameters.fields.type	string	Optional	Parameters for the Get File from Shared Link action
parameters.fields.name	string	Optional	Parameters for the Get File from Shared Link action
headers	object	Required	HTTP headers for the request
headers.boxapi	string	Required	HTTP headers for the request
headers.if-none-match	string	Optional	HTTP headers for the request

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"file","name":"Aaron Levie"}]},"headers":{"boxapi":"shared_link=[link]&shared_link_password=[password]","if-none-match":"1"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
allowed_invitee_roles	array	Output field: allowed_invitee_roles
purged_at	string	Output field: purged_at
representations	object	Output field: representations
representations.entries	array	Output field: representations.entries
representations.entries.content	object	Response content
representations.entries.content.url_template	string	URL endpoint for the request
representations.entries.info	object	Output field: representations.entries.info
representations.entries.info.url	string	URL endpoint for the request
representations.entries.properties	object	Output field: representations.entries.properties
representations.entries.properties.dimensions	string	Output field: representations.entries.properties.dimensions
representations.entries.properties.paged	boolean	Output field: representations.entries.properties.paged
representations.entries.properties.thumb	boolean	Output field: representations.entries.properties.thumb
representations.entries.representation	string	Output field: representations.entries.representation
representations.entries.status	object	Status value
representations.entries.status.state	string	Status value

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"12345","type":"file","allowed_invitee_roles":["editor"],"purged_at":"2012-12-12T10:53:43-08:00","representations":{"entries":[]}}}

Get Folder for Shared Link

Retrieve the folder associated with a shared link in Box, using authentication headers.

Endpoint

URL: /shared_items

Method: GET

Input

Argument Name	Type	Required	Description
parameters.fields	array	Optional	Parameters for the Get Folder for Shared Link action
parameters.fields.id	string	Optional	Parameters for the Get Folder for Shared Link action
parameters.fields.type	string	Optional	Parameters for the Get Folder for Shared Link action
parameters.fields.name	string	Optional	Parameters for the Get Folder for Shared Link action
headers	object	Required	HTTP headers for the request
headers.boxapi	string	Required	HTTP headers for the request
headers.if-none-match	string	Optional	HTTP headers for the request

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"folder","name":"Top Secret"}]},"headers":{"boxapi":"shared_link=[link]&shared_link_password=[password]","if-none-match":"1"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
allowed_invitee_roles	array	Output field: allowed_invitee_roles
allowed_shared_link_access_levels	array	Output field: allowed_shared_link_access_levels
name	string	Name of the resource
owned_by	object	Output field: owned_by
owned_by.id	string	Unique identifier
owned_by.type	string	Type of the resource
owned_by.login	string	Output field: owned_by.login
owned_by.name	string	Name of the resource

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"12345","type":"folder","allowed_invitee_roles":["editor"],"allowed_shared_link_access_levels":["open"],"name":"Contracts","owned_by":{"id":"11446498","type":"user","login":"[email protected]","name":"Aaron Levie"}}}

Get Group

Retrieves details for a specified group in Box, requiring the group_id as a path parameter.

Endpoint

URL: /groups/{{group_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.group_id	string	Required	Parameters for the Get Group action
parameters.fields	array	Optional	Parameters for the Get Group action
parameters.fields.id	string	Optional	Parameters for the Get Group action
parameters.fields.type	string	Optional	Parameters for the Get Group action
parameters.fields.name	string	Optional	Parameters for the Get Group action

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"group","name":"Aaron Levie"}]},"path_parameters":{"group_id":"57645"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
created_at	string	Output field: created_at
description	string	Output field: description
external_sync_identifier	string	Unique identifier
group_type	string	Type of the resource
invitability_level	string	Output field: invitability_level
member_viewability_level	string	Output field: member_viewability_level
modified_at	string	Output field: modified_at
name	string	Name of the resource
permissions	object	Output field: permissions
permissions.can_invite_as_collaborator	boolean	Output field: permissions.can_invite_as_collaborator
provenance	string	Output field: provenance

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"11446498","type":"group","created_at":"2012-12-12T10:53:43-08:00","description":"Support Group - as imported from Active Directory","external_sync_identifier":"AD:123456","group_type":"managed_group","invitability_level":"admins_only","member_viewability_level":"admins_only","modified_at":"2012-12-12T10:53:43-08:00","name":"Support","permissions":{"can_invite_as_collaborator":true},"provenance":"Active Directory"}}

Get List Items in Folder

Retrieves files, folders, and web links within a specified Box folder using the folder_id.

Endpoint

URL: /folders/{{folder_id}}/items

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.folder_id	string	Required	Parameters for the Get List Items in Folder action
parameters.direction	string	Optional	Parameters for the Get List Items in Folder action
parameters.limit	number	Optional	Parameters for the Get List Items in Folder action
parameters.marker	string	Optional	Parameters for the Get List Items in Folder action
parameters.offset	number	Optional	Parameters for the Get List Items in Folder action
parameters.sort	string	Optional	Parameters for the Get List Items in Folder action
parameters.usemarker	boolean	Optional	Parameters for the Get List Items in Folder action
parameters.fields	array	Optional	Parameters for the Get List Items in Folder action
parameters.fields.id	string	Optional	Parameters for the Get List Items in Folder action
parameters.fields.type	string	Optional	Parameters for the Get List Items in Folder action
parameters.fields.name	string	Optional	Parameters for the Get List Items in Folder action
headers	object	Optional	HTTP headers for the request
headers.boxapi	string	Optional	HTTP headers for the request

Input Example

{"parameters":{"direction":"ASC","limit":100,"marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","offset":0,"sort":"0","usemarker":false,"fields":[{"id":"11446498","type":"user","name":"Aaron Levie"}]},"path_parameters":{"folder_id":"123456"},"headers":{"boxapi":"shared_link=[link]&shared_link_password=[password]"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
limit	number	Output field: limit
offset	number	Output field: offset
order	array	Output field: order
order.by	string	Output field: order.by
order.direction	string	Output field: order.direction
total_count	number	Count value

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"limit":1000,"offset":2000,"order":[{}],"total_count":5000}}

Get List parts

Retrieve a list of uploaded file chunks in Box for a specific upload session using the provided upload_session_id.

Endpoint

URL: /files/upload_sessions/{{upload_session_id}}/parts

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.upload_session_id	string	Required	Parameters for the Get List parts action
parameters.limit	number	Optional	Parameters for the Get List parts action
parameters.offset	number	Optional	Parameters for the Get List parts action

Input Example

{"parameters":{"limit":100,"offset":0},"path_parameters":{"upload_session_id":"D5E3F7A"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
entries	array	Output field: entries
entries.part_id	string	Unique identifier
entries.offset	number	Output field: entries.offset
entries.size	number	Output field: entries.size
entries.sha1	string	Output field: entries.sha1
limit	number	Output field: limit
offset	number	Output field: offset
order	array	Output field: order
order.by	string	Output field: order.by
order.direction	string	Output field: order.direction
total_count	number	Count value

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"entries":[{}],"limit":1000,"offset":2000,"order":[{}],"total_count":5000}}

Get Metadata Query

Retrieves metadata query indices in Box using specified 'scope' and 'template_key' parameters.

Endpoint

URL: /metadata_query_indices

Method: GET

Input

Argument Name	Type	Required	Description
parameters.scope	string	Required	Parameters for the Get Metadata Query action
parameters.template_key	string	Required	Parameters for the Get Metadata Query action

Input Example

{"parameters":{"scope":"global","template_key":"properties"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
entries	array	Output field: entries
entries.id	string	Unique identifier
entries.type	string	Type of the resource
entries.status	string	Status value
entries.fields	array	Output field: entries.fields
entries.fields.key	string	Output field: entries.fields.key
entries.fields.sort_direction	string	Output field: entries.fields.sort_direction
limit	number	Output field: limit
next_marker	string	Output field: next_marker

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"entries":[{}],"limit":100,"next_marker":"0!-M7487OpVfBTNBV-XsQjU50gQFlbFFu5nArMWD7Ck61GH_Qo40M1S2xN5zWZPBzEjaQS1SOjJiQoo5..."}}

Get upload session

Retrieve details for a specific Box upload session using the provided upload_session_id.

Endpoint

URL: /files/upload_sessions/{{upload_session_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.upload_session_id	string	Required	Parameters for the Get upload session action

Input Example

{"path_parameters":{"upload_session_id":"D5E3F7A"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
num_parts_processed	number	Output field: num_parts_processed
part_size	number	Output field: part_size
session_endpoints	object	Output field: session_endpoints
session_endpoints.abort	string	Output field: session_endpoints.abort
session_endpoints.commit	string	Output field: session_endpoints.commit
session_endpoints.list_parts	string	Output field: session_endpoints.list_parts
session_endpoints.log_event	string	Output field: session_endpoints.log_event
session_endpoints.status	string	Status value
session_endpoints.upload_part	string	Output field: session_endpoints.upload_part
session_expires_at	string	Output field: session_expires_at
total_parts	number	Output field: total_parts

Output Example

Get User

Retrieves detailed information for a specified user in the Box enterprise environment by using their unique user ID.

Endpoint

URL: /users/{{user_id}}

Method: GET

Input

Argument Name	Type	Required	Description
path_parameters.user_id	string	Required	Parameters for the Get User action
parameters.fields	array	Optional	Parameters for the Get User action
parameters.fields.id	string	Optional	Parameters for the Get User action
parameters.fields.type	string	Optional	Parameters for the Get User action
parameters.fields.name	string	Optional	Parameters for the Get User action

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"user","name":"Aaron Levie"}]},"path_parameters":{"user_id":"12345"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
id	string	Unique identifier
type	string	Type of the resource
address	string	Output field: address
avatar_url	string	URL endpoint for the request
can_see_managed_users	boolean	Output field: can_see_managed_users
created_at	string	Output field: created_at
enterprise	object	Output field: enterprise
enterprise.id	string	Unique identifier
enterprise.type	string	Type of the resource
enterprise.name	string	Name of the resource
external_app_user_id	string	Unique identifier
hostname	string	Name of the resource
is_exempt_from_device_limits	boolean	Output field: is_exempt_from_device_limits
is_exempt_from_login_verification	boolean	Output field: is_exempt_from_login_verification
is_external_collab_restricted	boolean	Output field: is_external_collab_restricted
is_platform_access_only	boolean	Output field: is_platform_access_only
is_sync_enabled	boolean	Output field: is_sync_enabled
job_title	string	Output field: job_title
language	string	Output field: language
login	string	Output field: login
max_upload_size	number	Output field: max_upload_size
modified_at	string	Output field: modified_at
my_tags	array	Output field: my_tags

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"id":"11446498","type":"user","address":"900 Jefferson Ave, Redwood City, CA 94063","avatar_url":"https://www.box.com/api/avatar/large/181216415","can_see_managed_users":true,"created_at":"2012-12-12T10:53:43-08:00","enterprise":{"id":"11446498","type":"enterprise","name":"Acme Inc."},"external_app_user_id":"my-user-1234","hostname":"https://example.app.box.com/","is_exempt_from_device_limits":true,"is_exempt_from_login_verifica...

Get Workflows

Retrieves a list of manual-start workflows associated with a specified folder ID in Box, requiring the folder_id parameter.

Endpoint

URL: /workflows

Method: GET

Input

Argument Name	Type	Required	Description
parameters.folder_id	string	Required	Parameters for the Get Workflows action
parameters.limit	number	Optional	Parameters for the Get Workflows action
parameters.marker	string	Optional	Parameters for the Get Workflows action
parameters.trigger_type	string	Optional	Parameters for the Get Workflows action

Input Example

{"parameters":{"folder_id":"123456","limit":100,"marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","trigger_type":"WORKFLOW_MANUAL_START"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
entries	array	Output field: entries
entries.id	string	Unique identifier
entries.type	string	Type of the resource
entries.name	string	Name of the resource
entries.description	string	Output field: entries.description
entries.is_enabled	boolean	Output field: entries.is_enabled
entries.flows	array	Output field: entries.flows
entries.flows.id	string	Unique identifier
entries.flows.type	string	Type of the resource
entries.flows.trigger	object	Output field: entries.flows.trigger
entries.flows.trigger.type	string	Type of the resource
entries.flows.trigger.trigger_type	string	Type of the resource
entries.flows.trigger.scope	array	Output field: entries.flows.trigger.scope
entries.flows.trigger.scope.type	string	Type of the resource
entries.flows.trigger.scope.ref	string	Output field: entries.flows.trigger.scope.ref
entries.flows.trigger.scope.object	object	Output field: entries.flows.trigger.scope.object
entries.flows.outcomes	array	Output field: entries.flows.outcomes
entries.flows.outcomes.id	string	Unique identifier
entries.flows.outcomes.type	string	Type of the resource
entries.flows.outcomes.name	string	Name of the resource
entries.flows.outcomes.action_type	string	Type of the resource
entries.flows.outcomes.if_rejected	array	Output field: entries.flows.outcomes.if_rejected
entries.flows.outcomes.if_rejected.id	string	Unique identifier

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"entries":[{}],"limit":1000,"next_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii","prev_marker":"JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVih"}}

Remove upload session

Aborts and discards an ongoing Box upload session using the provided upload_session_id.

Endpoint

URL: /files/upload_sessions/{{upload_session_id}}

Method: DELETE

Input

Argument Name	Type	Required	Description
path_parameters.upload_session_id	string	Required	Parameters for the Remove upload session action

Input Example

{"path_parameters":{"upload_session_id":"D5E3F7A"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{}}

Upload_File

Uploads a small file to Box with specified data body, form data, and custom headers.

Endpoint

URL: /files/content

Method: POST

Input

Argument Name	Type	Required	Description
parameters.fields	array	Optional	Parameters for the Upload_File action
parameters.fields.id	string	Optional	Parameters for the Upload_File action
parameters.fields.type	string	Optional	Parameters for the Upload_File action
parameters.fields.name	string	Optional	Parameters for the Upload_File action
data_body	object	Required	Response data
data_body.attributes	object	Required	Response data
data_body.attributes.content_created_at	string	Required	Response data
data_body.attributes.content_modified_at	string	Required	Response data
data_body.attributes.name	string	Required	Response data
data_body.attributes.parent	object	Optional	Response data
data_body.attributes.parent.id	string	Required	Response data
form_data	object	Required	Response data
form_data.files	array	Required	Response data
form_data.files.file_name	string	Required	Response data
form_data.files.file	string	Required	Response data
headers	object	Required	HTTP headers for the request
headers.content-md5	string	Optional	HTTP headers for the request

Input Example

{"parameters":{"fields":[{"id":"11446498","type":"user","name":"Aaron Levie"}]},"data_body":{"attributes":{"content_created_at":"2012-12-12T10:53:43-08:00","content_modified_at":"2012-12-12T10:53:43-08:00","name":"Photo.png","parent":{"id":"124132"}}},"form_data":{"files":[{"file":"../data/files/s.png","file_name":"s.png"}]},"headers":{"content-md5":"134b65991ed521fcfe4724b7d814ab8ded5185dc"}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
entries	array	Output field: entries
entries.parent	object	Output field: entries.parent
entries.parent.id	string	Unique identifier
entries.parent.etag	string	Output field: entries.parent.etag
entries.parent.type	string	Type of the resource
entries.parent.sequence_id	string	Unique identifier
entries.parent.name	string	Name of the resource
entries.tags	array	Output field: entries.tags
entries.watermark_info	object	Output field: entries.watermark_info
entries.watermark_info.is_watermarked	boolean	Output field: entries.watermark_info.is_watermarked
entries.expires_at	string	Output field: entries.expires_at
entries.representations	object	Output field: entries.representations
entries.representations.entries	array	Output field: entries.representations.entries
entries.representations.entries.content	object	Response content
entries.representations.entries.content.url_template	string	URL endpoint for the request
entries.representations.entries.info	object	Output field: entries.representations.entries.info
entries.representations.entries.info.url	string	URL endpoint for the request
entries.representations.entries.properties	object	Output field: entries.representations.entries.properties
entries.representations.entries.properties.dimensions	string	Output field: entries.representations.entries.properties.dimensions
entries.representations.entries.properties.paged	boolean	Output field: entries.representations.entries.properties.paged
entries.representations.entries.properties.thumb	boolean	Output field: entries.representations.entries.properties.thumb
entries.representations.entries.representation	string	Output field: entries.representations.entries.representation
entries.representations.entries.status	object	Status value

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"entries":[{}],"total_count":1}}

Upload File Version

Upload a new version of a file to Box using the file's unique ID, with support for path parameters and form data.

Endpoint

URL: /files/{{file_id}}/content

Method: POST

Input

Argument Name	Type	Required	Description
parameters.fields	array	Optional	list of attributes to include in the response.
path_parameters.file_id	string	Required	The unique identifier that represents a file.
headers	object	Optional	HTTP headers for the request
headers.if-match	string	Optional	Ensures this item hasn't recently changed before making changes.
headers.content-md5	string	Optional	An optional header containing the SHA1 hash of the file to ensure that the file was not corrupted in transit.
data_body	object	Required	Response data
data_body.attributes	object	Required	The additional attributes of the file being uploaded.
data_body.attributes.name	string	Required	An optional new name for the file.
data_body.attributes.content_modified_at	string	Optional	Defines the time the file was last modified at.
form_data	object	Required	Response data
form_data.files	array	Required	The content of the file to upload to Box.
form_data.files.file_name	string	Required	Response data
form_data.files.file	string	Required	Response data

Input Example

{"parameters":{"fields":["metadata","classification","representations","expiring_embed_link","uploader_display_name"]},"path_parameters":{"file_id":"123"},"headers":{"if-match":"1","content-md5":"Q2hlY2sgSW50ZWdyaXR5IQ=="},"data_body":{"attributes":{"name":"Photo 2.0.png","content_modified_at":"2012-12-12T10:53:43-08:00"},"file":"file_content"},"form_data":{"files":[{"file":"../data/files/s.png","file_name":"s.png"}]}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
total_count	number	Count value
entries	array	Output field: entries
entries.id	string	Unique identifier
entries.type	string	Type of the resource
entries.etag	string	Output field: entries.etag
entries.sequence_id	string	Unique identifier
entries.name	string	Name of the resource
entries.sha1	string	Output field: entries.sha1
entries.file_version	object	Output field: entries.file_version
entries.file_version.id	string	Unique identifier
entries.file_version.type	string	Type of the resource
entries.file_version.sha1	string	Output field: entries.file_version.sha1
entries.description	string	Output field: entries.description
entries.size	number	Output field: entries.size
entries.path_collection	object	Output field: entries.path_collection
entries.path_collection.total_count	number	Count value
entries.path_collection.entries	array	Output field: entries.path_collection.entries
entries.path_collection.entries.id	string	Unique identifier
entries.path_collection.entries.type	string	Type of the resource
entries.path_collection.entries.etag	string	Output field: entries.path_collection.entries.etag
entries.path_collection.entries.sequence_id	string	Unique identifier
entries.path_collection.entries.name	string	Name of the resource
entries.created_at	string	Output field: entries.created_at

Output Example

{"status_code":200,"reason":"OK","json_body":{"total_count":1,"entries":[{}]}}

Upload part of file

Updates a specific chunk of a file in an ongoing Box upload session, using the provided upload_session_id.

Endpoint

URL: /files/upload_sessions/{{upload_session_id}}

Method: PUT

Input

Argument Name	Type	Required	Description
path_parameters.upload_session_id	string	Required	Parameters for the Upload part of file action
headers	object	Required	HTTP headers for the request
headers.content-range	string	Required	HTTP headers for the request
headers.digest	string	Required	HTTP headers for the request

Input Example

{"path_parameters":{"upload_session_id":"D5E3F7A"},"headers":{"content-range":"bytes 8388608-16777215/445856194","digest":"sha=fpRyg5eVQletdZqEKaFlqwBXJzM="}}

Output

Parameter	Type	Description
status_code	number	HTTP status code of the response
reason	string	Response reason phrase
part	object	Output field: part
part.offset	number	Output field: part.offset
part.part_id	string	Unique identifier
part.sha1	string	Output field: part.sha1
part.size	number	Output field: part.size

Output Example

{"status_code":200,"reason":"OK","response_headers":{},"json_body":{"part":{"offset":16777216,"part_id":"6F2D3486","sha1":"134b65991ed521fcfe4724b7d814ab8ded5185dc","size":3222784}}}

Response Headers

Header	Description	Example
Content-Type	The media type of the resource	application/json
Date	The date and time at which the message was originated	Thu, 01 Jan 2024 00:00:00 GMT