Skip to main content
API version 2024.0 Represents a trashed web link.
​
id
string
example: 11446498The unique identifier for this web link.
​
type
string
example: web_linkThe value will always be web_link.Value is always web_link
​
created_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When this file was created on Box’s servers.
​
created_by
User (Mini)object
The user who created this web link.
​
description
string
example: Example pageThe description accompanying the web link. This is visible within the Box web application.
​
etag
string
example: 1The entity tag of this web link. Used with If-Match headers.
​
item_status
string
example: trashedWhether 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
​
modified_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When this file was last updated on the Box servers.
​
modified_by
User (Mini)object
The user who last modified this web link.
​
name
string
example: My BookmarkThe name of the web link.
​
owned_by
User (Mini)object
The user who owns this web link.
​
parent
Folder (Mini)object
The parent object the web link belongs to.
​
path_collection
object
The tree of folders that this web link is contained in, starting at the root.
​
purged_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When this file will be permanently deleted.
​
sequence_id
string
example: 3A 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.
​
shared_link
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.
​
trashed_at
string(date-time)
example: 2012-12-12T10:53:43-08:00When this file was last moved to the trash.
​
url
string
example: https://www.example.com/example/1234The URL this web link points to.
{
  "id": "11446498",
  "type": "web_link",
  "created_at": "2012-12-12T10:53:43-08:00",
  "created_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "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": "[email protected]",
    "name": "Aaron Levie"
  },
  "name": "My Bookmark",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "[email protected]",
    "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"
}