Join BoxWorks 2024 to discover what's possible with content and AI!

Web link (Base)

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.

Standard
Mini
Base

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.

id string

example11446498

The unique identifier for this web link

type string

exampleweb_link

web_link

Value is always web_link

etag string

example1

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

Response Example

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