Box Developer Documentation
Log in

A beta version of the new Box developer documentation site is launching soon! Updated Developer Guides, modern API Reference, and AI-powered search are on the way to help you build with Box faster. Stay tuned for more updates.

Web link (Base)

This resource is used by endpoints in the version 2024.0. For more details, see Box API versioning.

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 file objects, they will also support most actions that apply to regular files.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

string
11446498

The unique identifier for this web link.

string
web_link

The value will always be web_link.

Value is always web_link

string
1

The entity tag of this web link. Used with If-Match headers.

Response Example

{
  "id": "11446498",
  "type": "web_link",
  "etag": "1"
}