> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Trashed web links resources
Web links that were deleted and are in the trash.
## Trashed Web Link
Represents a trashed web link.
| Property | Type | Required | Description |
| ----------------- | --------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | `enum` | No | The value will always be `web_link`. Available options: `web_link`. |
| `id` | `string` | No | The unique identifier for this web link. |
| `sequence_id` | `string` | No | 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. Can be `null`. |
| `etag` | `string` | No | The entity tag of this web link. Used with `If-Match` headers. |
| `name` | `string` | No | The name of the web link. |
| `url` | `string` | No | The URL this web link points to. |
| `parent` | [Folder (Mini)](/reference/folders-resources#folder-mini) | No | The parent object the web link belongs to. |
| `description` | `string` | No | The description accompanying the web link. This is visible within the Box web application. |
| `path_collection` | `object` | No | A list of parent folders for an item in the trash. |
| `created_at` | `string` | No | When this file was created on Box’s servers. |
| `modified_at` | `string` | No | When this file was last updated on the Box servers. |
| `trashed_at` | `string` | No | When this file was last moved to the trash. Can be `null`. |
| `purged_at` | `string` | No | When this file will be permanently deleted. Can be `null`. |
| `created_by` | [User (Mini)](/reference/users-resources#user-mini) | No | The user who created this web link. |
| `modified_by` | [User (Mini)](/reference/users-resources#user-mini) | No | The user who last modified this web link. |
| `owned_by` | [User (Mini)](/reference/users-resources#user-mini) | No | The user who owns this web link. |
| `shared_link` | `string` | No | The shared link for this bookmark. This will be `null` if a bookmark has been trashed, since the link will no longer be active. Can be `null`. |
| `item_status` | `enum` | No | 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. Available options: `active`, `trashed`, `deleted`. |
```json Example theme={null}
{
"type": "web_link",
"id": "11446498",
"sequence_id": "3",
"etag": "1",
"name": "My Bookmark",
"url": "https://www.example.com/example/1234",
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"description": "Example page",
"path_collection": {
"total_count": 1,
"entries": [
{
"type": "folder",
"id": "123456789",
"sequence_id": null,
"etag": null,
"name": "Trash"
}
]
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"trashed_at": "2012-12-12T10:53:43-08:00",
"purged_at": "2012-12-12T10:53:43-08:00",
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": null,
"item_status": "trashed"
}
```
## Trashed Web Link (Restored)
Represents a web link restored from the trash.
| Property | Type | Required | Description |
| ----------------- | --------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `type` | `enum` | No | The value will always be `web_link`. Available options: `web_link`. |
| `id` | `string` | No | The unique identifier for this web link. |
| `sequence_id` | `string` | Yes | 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. Can be `null`. |
| `etag` | `string` | No | The entity tag of this web link. Used with `If-Match` headers. |
| `name` | `string` | No | The name of the web link. |
| `url` | `string` | No | The URL this web link points to. |
| `parent` | [Folder (Mini)](/reference/folders-resources#folder-mini) | No | The parent object the web link belongs to. |
| `description` | `string` | No | The description accompanying the web link. This is visible within the Box web application. |
| `path_collection` | `object` | Yes | A list of parent folders for an item. |
| `created_at` | `string` | No | When this file was created on Box’s servers. |
| `modified_at` | `string` | No | When this file was last updated on the Box servers. |
| `trashed_at` | `string` | No | The time at which this bookmark was put in the trash - becomes `null` after restore. Can be `null`. |
| `purged_at` | `string` | No | The time at which this bookmark will be permanently deleted - becomes `null` after restore. Can be `null`. |
| `created_by` | [User (Mini)](/reference/users-resources#user-mini) | No | The user who created this web link. |
| `modified_by` | [User (Mini)](/reference/users-resources#user-mini) | No | The user who last modified this web link. |
| `owned_by` | [User (Mini)](/reference/users-resources#user-mini) | No | The user who owns this web link. |
| `shared_link` | `string` | No | The shared link for this bookmark. This will be `null` if a bookmark had been trashed, even though the original shared link does become active again. Can be `null`. |
| `item_status` | `enum` | No | 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. Available options: `active`, `trashed`, `deleted`. |
```json Example theme={null}
{
"type": "web_link",
"id": "11446498",
"sequence_id": "3",
"etag": "1",
"name": "My Bookmark",
"url": "https://www.example.com/example/1234",
"parent": {
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
},
"description": "Example page",
"path_collection": {
"total_count": 1,
"entries": [
{
"id": "12345",
"etag": "1",
"type": "folder",
"sequence_id": "3",
"name": "Contracts"
}
]
},
"created_at": "2012-12-12T10:53:43-08:00",
"modified_at": "2012-12-12T10:53:43-08:00",
"trashed_at": null,
"purged_at": null,
"created_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"modified_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"owned_by": {
"id": "11446498",
"type": "user",
"name": "Aaron Levie",
"login": "ceo@example.com"
},
"shared_link": null,
"item_status": "trashed"
}
```