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

The Box API provides a way to find content in Boxusing full-text search queries.

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

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

This API exposes 2 operations across 2 paths, and defines 32 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.

2 operations 2 paths 32 schemas 1 GET1 POST

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 Search API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes.

Paths & Operations 2

Across 2 paths, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Search 2

The Box API provides a way to find content in Box using full-text search queries.

POST
/metadata_queries/execute_read
Box Query files/folders by metadata
post_metadata_queries_execute_read body → 200400404default
GET
/search
Box Search for content
get_search 21 params → 200400403404default

Schemas 32

The contract defines 32 schemas that model the data the API accepts and returns. The most detailed are MetadataQuery (8 properties), ClientError_2 (7 properties), ClientError (7 properties), Metadata--Base (4 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
MetadataFieldFilterMultiSelect
object
Specifies the values to match for a multiSelect metadata field. When performing a search, the query will essentially perform an OR operation to match any templ…
ClientError
object
A generic error
7 properties
MetadataQueryResults
object
A page of files and folders that matched the metadata query.
3 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
MetadataFieldFilterFloat
object
Specifies which float field on the template to filter the search results by.
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
User--Mini
object
A mini representation of a user, as can be returned when nested within other resources.
Items
object
A list of files, folders, and web links in their mini representation.
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.
Metadata--Base
object
The base representation of a metadata instance.
4 properties
FileOrFolderScope
object
A relation between a resource (file or folder) and the scopes for which the resource can be accessed
2 properties
SearchResults
object
A list of files, folders and web links that matched the search query.
1 required
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.
MetadataQuery
object
Create a search using SQL-like syntax to return items that match specific metadata.
8 properties 2 required
SearchResultsWithSharedLinks
object
A list of files, folders and web links that matched the search query, including the additional information about any shared links through which the item has be…
1 required
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…
Metadata
object
An instance of a metadata template, which has been applied to a file or folder.
MetadataFieldFilterDateRange
object
Specifies which date field on the template to filter the search results by, specifying a range of dates that can match.
MetadataFilter
object
A metadata template to filter the search results by.
3 properties
Folder--Full
object
A full representation of a folder, as can be returned from any folder API endpoints by default
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
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
MetadataFieldFilterString
object
Specifies which text field on the template to filter the search results by.
SearchResultWithSharedLink
object
A single of files, folder or web link that matched the search query, including the additional information about the shared link through which the item has been…
3 properties
MetadataFieldFilterFloatRange
object
Specifies which float field on the template to filter the search results by, specifying a range of values that can match.
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-search-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 Search 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.