Box Developer Documentation
Log in

Trashed Web Link

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

Represents a trashed web link.

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 (date-time)
2012-12-12T10:53:43-08:00

When this file was created on Box’s servers.

User (Mini) object

The user who created this web link.

string
Example page

The description accompanying the web link. This is visible within the Box web application.

string
1

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

string
trashed

Whether this item is deleted or not. Values include active, trashed if the file has been moved to the trash, and deleted if the file has been permanently deleted.

Value is one of active,trashed,deleted

string (date-time)
2012-12-12T10:53:43-08:00

When this file was last updated on the Box servers.

User (Mini) object

The user who last modified this web link.

string
My Bookmark

The name of the web link.

User (Mini) object

The user who owns this web link.

Folder (Mini) object

The parent object the web link belongs to.

object

The tree of folders that this web link is contained in, starting at the root.

object array

Array of folders for this item's path collection.

string
123456789

The unique identifier that represent a folder.

string
folder

The value will always be folder.

Value is always folder

string

This field is null for the Trash folder.

string
Trash

The name of the Trash folder.

string

This field is null for the Trash folder.

integer (int64)
1

The number of folders in this list.

string (date-time)
2012-12-12T10:53:43-08:00

When this file will be permanently deleted.

string
3

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

string

The shared link for this bookmark. This will be null if a bookmark has been trashed, since the link will no longer be active.

string (date-time)
2012-12-12T10:53:43-08:00

When this file was last moved to the trash.

string
https://www.example.com/example/1234

The URL this web link points to.

Response Example

{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Example page",
  "etag": "1",
  "item_status": "trashed",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "path_collection": {
    "entries": [
      {
        "etag": "null",
        "id": "123456789",
        "name": "Trash",
        "sequence_id": "null",
        "type": "folder"
      }
    ],
    "total_count": 1
  },
  "purged_at": "2012-12-12T10:53:43-08:00",
  "sequence_id": "3",
  "shared_link": "null",
  "trashed_at": "2012-12-12T10:53:43-08:00",
  "url": "https://www.example.com/example/1234"
}