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 Shared Links (Web Links) API

Web links for files are URLs that are generatedfor web links in Box,which provide direct, read-only access to the resource.

Box Shared Links (Web Links) API is one of 81 APIs that Box publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Shared Links (Web Links). The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

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

5 operations 5 paths 8 schemas 2 GET3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://account.box.com/api/oauth2
Authentication
OAuth 2.0
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

Box Shared Links (Web Links) API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (OAuth2Security) using the authorizationCode flow, exposing 9 scopes. By default, every request must be authenticated.

Paths & Operations 5

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

Shared Links (Web Links) 5

Web links for files are URLs that are generated for web links in Box, which provide direct, read-only access to the resource.

GET
/shared_items#web_links
Box Find web link for shared link
get_shared_items#web_links 3 params → 200304default
GET
/web_links/{web_link_id}#get_shared_link
Box Get shared link for web link
get_web_links_id#get_shared_link 2 params → 200401404405default
PUT
/web_links/{web_link_id}#add_shared_link
Box Add shared link to web link
put_web_links_id#add_shared_link 2 params body → 200400401403404405412default
PUT
/web_links/{web_link_id}#update_shared_link
Box Update shared link on web link
put_web_links_id#update_shared_link 2 params body → 200400401403404405412default
PUT
/web_links/{web_link_id}#remove_shared_link
Box Remove shared link from web link
put_web_links_id#remove_shared_link 2 params body → 200401403404405412default

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ClientError (7 properties), WebLink--Base (3 properties), Folder--Base (3 properties), User--Base (2 properties). Each schema is shown below with its type and property counts.

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.
Folder--Mini
object
A mini representation of a file version, used when nested under another resource.
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--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…
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…
User--Base
object
A mini representation of a user, used when nested within another resource.
2 properties 2 required
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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

box-shared-links-web-links-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 Shared Links (Web Links) 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.