How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Box Files API

Files, together with Folders,are at the core of the Box API.Files can be uploaded and downloaded,as well as hold important metadatainformation about the content.

Box Files API is one of 81 APIs that Box publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include File. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 47 operations across 26 paths, and defines 41 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://api.box.com/2.0.

47 operations 26 paths 41 schemas 8 DELETE17 GET1 OPTIONS11 POST10 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://account.box.com/api/oauth2
Authentication
OAuth 2.0
Resource Areas
1

Authentication & Security 1

Box Files API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 47

Across 26 paths, the API surfaces 47 operations — 8 DELETE, 17 GET, 1 OPTIONS, 11 POST, 10 PUT. Each is listed below with its method, path, parameters, and response codes.

Files 47

Files, together with Folders, are at the core of the Box API. Files can be uploaded and downloaded, as well as hold important metadata information about the content.

GET
/files/{file_id}
Box Get file information
get_files_id 5 params → 200304401404405415default
PUT
/files/{file_id}
Box Update file
put_files_id 3 params body → 200400401403404405412default
DELETE
/files/{file_id}
Box Delete file
delete_files_id 2 params → 204401404405412default
POST
/files/{file_id}
Box Restore file
post_files_id 2 params body → 201403404409default
OPTIONS
/files/content
Box Preflight check before upload
options_files_content body → 200409default
POST
/files/content
Box Upload file
post_files_content 2 params body → 201400404409default
POST
/files/{file_id}/copy
Box Copy file
post_files_id_copy 2 params body → 201304400403404409default
GET
/files/{file_id}/thumbnail.{extension}
Box Get file thumbnail
get_files_id_thumbnail_id 6 params → 200202302400403404default
GET
/files/{file_id}/collaborations
Box List file collaborations
get_files_id_collaborations 4 params → 200default
GET
/files/{file_id}/comments
Box List file comments
get_files_id_comments 4 params → 200default
GET
/files/{file_id}/content
Box Download file
get_files_id_content 5 params → 200202302default
POST
/files/{file_id}/content
Box Upload file version
post_files_id_content 4 params body → 200412default
POST
/files/upload_sessions
Box Create upload session
post_files_upload_sessions body → 201400403404409default
POST
/files/{file_id}/upload_sessions
Box Create upload session for existing file
post_files_id_upload_sessions 1 param body → 201409default
GET
/files/upload_sessions/{upload_session_id}
Box Get upload session
get_files_upload_sessions_id 1 param → 200default
PUT
/files/upload_sessions/{upload_session_id}
Box Upload part of file
put_files_upload_sessions_id 3 params body → 200409412416default
DELETE
/files/upload_sessions/{upload_session_id}
Box Remove upload session
delete_files_upload_sessions_id 1 param → 204default
GET
/files/upload_sessions/{upload_session_id}/parts
Box List parts
get_files_upload_sessions_id_parts 3 params → 200default
POST
/files/upload_sessions/{upload_session_id}/commit
Box Commit upload session
post_files_upload_sessions_id_commit 4 params body → 201202409412default
GET
/files/{file_id}/tasks
Box List tasks on file
get_files_id_tasks 1 param → 200404405500default
GET
/files/{file_id}/trash
Box Get trashed file
get_files_id_trash 2 params → 200404default
DELETE
/files/{file_id}/trash
Box Permanently remove file
delete_files_id_trash 1 param → 204404default
GET
/files/{file_id}/versions
Box List all file versions
get_files_id_versions 4 params → 200default
GET
/files/{file_id}/versions/{file_version_id}
Box Get file version
get_files_id_versions_id 3 params → 200default
DELETE
/files/{file_id}/versions/{file_version_id}
Box Remove file version
delete_files_id_versions_id 3 params → 204default
PUT
/files/{file_id}/versions/{file_version_id}
Box Restore file version
put_files_id_versions_id 2 params body → 200default
POST
/files/{file_id}/versions/current
Box Promote file version
post_files_id_versions_current 2 params body → 201default
GET
/files/{file_id}/metadata
Box List metadata instances on file
get_files_id_metadata 1 param → 200403404default
GET
/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Get classification on file
get_files_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param → 201403404405default
POST
/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Add classification to file
post_files_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param body → 201400404409default
PUT
/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Update classification on file
put_files_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param body → 200400500default
DELETE
/files/{file_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Remove classification from file
delete_files_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param → 204400404405default
GET
/files/{file_id}/metadata/{scope}/{template_key}
Box Get metadata instance on file
get_files_id_metadata_id_id 3 params → 201403404405default
POST
/files/{file_id}/metadata/{scope}/{template_key}
Box Create metadata instance on file
post_files_id_metadata_id_id 3 params body → 201400404409default
PUT
/files/{file_id}/metadata/{scope}/{template_key}
Box Update metadata instance on file
put_files_id_metadata_id_id 3 params body → 200400500default
DELETE
/files/{file_id}/metadata/{scope}/{template_key}
Box Remove metadata instance from file
delete_files_id_metadata_id_id 3 params → 204400404405default
GET
/files/{file_id}/metadata/global/boxSkillsCards
List Box Skill cards on file
get_files_id_metadata_global_boxSkillsCards 1 param → 200default
POST
/files/{file_id}/metadata/global/boxSkillsCards
Create Box Skill cards on file
post_files_id_metadata_global_boxSkillsCards 1 param body → 201400404409default
PUT
/files/{file_id}/metadata/global/boxSkillsCards
Update Box Skill cards on file
put_files_id_metadata_global_boxSkillsCards 1 param body → 200404default
DELETE
/files/{file_id}/metadata/global/boxSkillsCards
Remove Box Skill cards from file
delete_files_id_metadata_global_boxSkillsCards 1 param → 204404405default
GET
/files/{file_id}/watermark
Box Get watermark on file
get_files_id_watermark 1 param → 200404default
PUT
/files/{file_id}/watermark
Box Apply watermark to file
put_files_id_watermark 1 param body → 200201default
DELETE
/files/{file_id}/watermark
Box Remove watermark from file
delete_files_id_watermark 1 param → 204404default
GET
/files/{file_id}#get_shared_link
Box Get shared link for file
get_files_id#get_shared_link 2 params → 200401404405default
PUT
/files/{file_id}#add_shared_link
Box Add shared link to file
put_files_id#add_shared_link 2 params body → 200400401403404405412default
PUT
/files/{file_id}#update_shared_link
Box Update shared link on file
put_files_id#update_shared_link 2 params body → 200400401403404405412default
PUT
/files/{file_id}#remove_shared_link
Box Remove shared link from file
put_files_id#remove_shared_link 2 params body → 200401403404405412default

Schemas 41

The contract defines 41 schemas that model the data the API accepts and returns. The most detailed are TrashFile (22 properties), Collaboration (14 properties), Task (11 properties), SkillCardsMetadata (9 properties). Each schema is shown below with its type and property counts.

File--Full
object
A full representation of a file, as can be returned from any file API endpoints by default
ClientError
object
A generic error
7 properties
User--Mini
object
A mini representation of a user, as can be returned when nested within other resources.
FileVersion--Mini
object
A mini representation of a file version, used when nested within another resource.
File
object
A standard representation of a file, as returned from any file API endpoints by default
File--Mini
objectnull
A mini representation of a file, used when nested under another resource.
UploadUrl
object
The details for the upload session for the file.
2 properties
Folder--Mini
object
A mini representation of a file version, used when nested under another resource.
FileVersion--Base
object
The bare basic representation of a file version, the minimal amount of fields returned when using the fields query parameter.
2 properties 2 required
Metadata
object
An instance of a metadata template, which has been applied to a file or folder.
Metadata--Base
object
The base representation of a metadata instance.
4 properties
ConflictError
object
The error that occurs when a file can not be created due to a conflict.
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
FileConflict
object
A representation of a file that is used to show
File--Base
objectnull
The bare basic representation of a file, the minimal amount of fields returned when using the fields query parameter.
3 properties 2 required
FileOrFolderScope
object
A relation between a resource (file or folder) and the scopes for which the resource can be accessed
2 properties
Folder--Base
object
The bare basic representation of a folder, the minimal amount of fields returned when using the fields query parameter.
3 properties 2 required
ClientError_2
object
A generic error
7 properties
Collaborations
object
A list of collaborations
Collaboration
object
Collaborations define access permissions for users and groups to files and folders, similar to access control lists. A collaboration object grants a user or gr…
14 properties 2 required
ClientError_3
object
A generic error
7 properties
Comments
object
A list of comments
Comment--Full
object
Comments are messages created on files. Comments can be made independently or created as responses to other comments
Metadata--Full
object
An instance of a metadata template, which has been applied to a file or folder.
Watermark
object
A watermark is a semi-transparent overlay on an embedded file preview that displays a viewer's email address or user ID and the time of access over a file's co…
1 property
UploadedPart
object
A chunk of a file uploaded as part of an upload session, as returned by some endpoints.
1 property
File--Full_2
object
A full representation of a file, as can be returned from any file API endpoints by default
UploadSession
object
An upload session for chunk uploading a file.
7 properties
SkillCardsMetadata
object
The metadata assigned to a using for Box skills.
9 properties
UploadParts
object
A list of uploaded chunks for an upload session.
ClientError_4
object
A generic error
7 properties
Files
object
A list of files
2 properties
FileVersion--Full
object
A full representation of a file version, as can be returned from any file version API endpoints by default
Tasks
object
A list of tasks
2 properties
Metadatas
object
A list of metadata instances that have been applied to a file or folder.
2 properties
FileVersions
object
A list of file versions
TrashFile
object
Represents a trashed file.
22 properties 12 required
Classification
object
An instance of the classification metadata template, containing the classification applied to the file or folder. To get more details about the classification…
8 properties
Task
object
A task allows for file-centric workflows within Box. Users can create tasks on files and assign them to other users for them to complete the tasks.
11 properties
TaskAssignments
object
A list of task assignments
2 properties
ClientError_5
object
A generic error
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-files-api-openapi.yml Raw ↑

Other APIs Box publishes across the network.

Box Authorization API
Box Authorize API
Box Classifications API
Box Classifications on Files API
Box Classifications on Folders API
Box Collaboration Whitelist Entries API
Box Collaboration Whitelist Exempt Targets API
Box Collaborations API
Box Collaborations (List) API
Box Collections API
Box Comments API
Box Device Pinners API
Where this information came from

This is an independent, third-party profile of Box Files API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.