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 Folders API

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

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

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

This API exposes 27 operations across 15 paths, and defines 30 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.

27 operations 15 paths 30 schemas 5 DELETE10 GET5 POST7 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 Folders API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 27

Across 15 paths, the API surfaces 27 operations — 5 DELETE, 10 GET, 5 POST, 7 PUT. Each is listed below with its method, path, parameters, and response codes.

Folders 27

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

GET
/folders/{folder_id}
Box Get folder information
get_folders_id 8 params → 200304403404405default
PUT
/folders/{folder_id}
Box Update folder
put_folders_id 3 params body → 200400403404409412503default
DELETE
/folders/{folder_id}
Box Delete folder
delete_folders_id 3 params → 204400403404409412503default
POST
/folders/{folder_id}
Box Restore folder
post_folders_id 2 params body → 201403404409default
GET
/folders/{folder_id}/items
Box List items in folder
get_folders_id_items 9 params → 200403404405default
POST
/folders
Box Create folder
post_folders 1 param body → 201400403404409default
POST
/folders/{folder_id}/copy
Box Copy folder
post_folders_id_copy 2 params body → 201304400403404409500default
GET
/folders/{folder_id}/collaborations
Box List folder collaborations
get_folders_id_collaborations 2 params → 200default
GET
/folders/{folder_id}/trash
Box Get trashed folder
get_folders_id_trash 2 params → 200404default
DELETE
/folders/{folder_id}/trash
Box Permanently remove folder
delete_folders_id_trash 1 param → 204404default
GET
/folders/{folder_id}/metadata
Box List metadata instances on folder
get_folders_id_metadata 1 param → 200403404default
GET
/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Get classification on folder
get_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param → 201403404405default
POST
/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Add classification to folder
post_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param body → 201400404409default
PUT
/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Update classification on folder
put_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param body → 200400500default
DELETE
/folders/{folder_id}/metadata/enterprise/securityClassification-6VMVochwUWo
Box Remove classification from folder
delete_folders_id_metadata_enterprise_securityClassification-6VMVochwUWo 1 param → 204400404405default
GET
/folders/{folder_id}/metadata/{scope}/{template_key}
Box Get metadata instance on folder
get_folders_id_metadata_id_id 3 params → 201403404405default
POST
/folders/{folder_id}/metadata/{scope}/{template_key}
Box Create metadata instance on folder
post_folders_id_metadata_id_id 3 params body → 201400404409default
PUT
/folders/{folder_id}/metadata/{scope}/{template_key}
Box Update metadata instance on folder
put_folders_id_metadata_id_id 3 params body → 200400500default
DELETE
/folders/{folder_id}/metadata/{scope}/{template_key}
Box Remove metadata instance from folder
delete_folders_id_metadata_id_id 3 params → 204400404405default
GET
/folders/trash/items
Box List trashed items
get_folders_trash_items 7 params → 200400default
GET
/folders/{folder_id}/watermark
Box Get watermark for folder
get_folders_id_watermark 1 param → 200404default
PUT
/folders/{folder_id}/watermark
Box Apply watermark to folder
put_folders_id_watermark 1 param body → 200201default
DELETE
/folders/{folder_id}/watermark
Box Remove watermark from folder
delete_folders_id_watermark 1 param → 204404default
GET
/folders/{folder_id}#get_shared_link
Box Get shared link for folder
get_folders_id#get_shared_link 2 params → 200401404405default
PUT
/folders/{folder_id}#add_shared_link
Box Add shared link to folder
put_folders_id#add_shared_link 2 params body → 200400401403404405412default
PUT
/folders/{folder_id}#update_shared_link
Box Update shared link on folder
put_folders_id#update_shared_link 2 params body → 200400401403404405412default
PUT
/folders/{folder_id}#remove_shared_link
Box Remove shared link from folder
put_folders_id#remove_shared_link 2 params body → 200401403404405412default

Schemas 30

The contract defines 30 schemas that model the data the API accepts and returns. The most detailed are TrashFolder (21 properties), Collaboration (14 properties), Classification (8 properties), ClientError (7 properties). Each schema is shown below with its type and property counts.

Folder
object
A standard representation of a folder, as returned from any folder API endpoints by default
ClientError
object
A generic error
7 properties
FileVersion--Mini
object
A mini representation of a file version, used when nested within 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
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
Items
object
A list of files, folders, and web links in their mini representation.
User--Mini
object
A mini representation of a user, as can be returned when nested within other resources.
Metadata--Base
object
The base representation of a metadata instance.
4 properties
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.
FileOrFolderScope
object
A relation between a resource (file or folder) and the scopes for which the resource can be accessed
2 properties
File--Full
object
A full representation of a file, as can be returned from any file API endpoints by default
Folder--Mini
object
A mini representation of a file version, used when nested under another resource.
Metadata
object
An instance of a metadata template, which has been applied to a file or folder.
WebLink--Mini
object
Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to f…
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
Folder--Full
object
A full representation of a folder, as can be returned from any folder API endpoints by default
WebLink--Base
object
Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to f…
3 properties 2 required
WebLink
object
Web links are objects that point to URLs. These objects are also known as bookmarks within the Box web application. Web link objects are treated similarly to f…
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
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
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
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
ClientError_3
object
A generic error
7 properties
Metadatas
object
A list of metadata instances that have been applied to a file or folder.
2 properties
Folder--Full_2
object
A full representation of a folder, as can be returned from any folder API endpoints by default
TrashFolder
object
Represents a trashed folder.
21 properties 10 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-folders-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 Folders 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.