---
title: "Get trashed web link"
method: GET
path: "/web_links/{web_link_id}/trash"
tags: ["Trashed web links"]
---

# Get trashed web link

`GET /web_links/{web_link_id}/trash`

Retrieves a web link that has been moved to the trash.

## Path parameters

- `web_link_id` string, required

## Query parameters

- `fields` string[]

## Response `200`

Returns the web link that was trashed,
including information about when the it
was moved to the trash.

- TrashWebLink — Represents a trashed web link.
  - `type` 'web_link' — The value will always be `web_link`.
  - `id` string — The unique identifier for this web link.
  - `sequence_id` string — 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.
  - `etag` string — The entity tag of this web link. Used with `If-Match` headers.
  - `name` string — The name of the web link.
  - `url` string — The URL this web link points to.
  - `parent` object — The parent object the web link belongs to.
    - `id` string, required — The unique identifier that represent a folder. The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL `https://*.app.box.com/folders/123` the `folder_id` is `123`.
    - `etag` string, nullable — The HTTP `etag` of this folder. This can be used within some API endpoints in the `If-Match` and `If-None-Match` headers to only perform changes on the folder if (no) changes have happened.
    - `type` 'folder', required — The value will always be `folder`.
    - `sequence_id` string — 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.
    - `name` string — The name of the folder.
  - `description` string — The description accompanying the web link. This is visible within the Box web application.
  - `path_collection` object — The tree of folders that this web link is contained in, starting at the root.
    - `total_count` integer, required — The number of folders in this list.
    - `entries` object[], required — Array of folders for this item's path collection.
      - `type` 'folder' — The value will always be `folder`.
      - `id` string — The unique identifier that represent a folder.
      - `sequence_id` string, nullable — This field is null for the Trash folder.
      - `etag` string, nullable — This field is null for the Trash folder.
      - `name` string — The name of the Trash folder.
  - `created_at` string, date-time — When this file was created on Box’s servers.
  - `modified_at` string, date-time — When this file was last updated on the Box servers.
  - `trashed_at` string, date-time, nullable — When this file was last moved to the trash.
  - `purged_at` string, date-time, nullable — When this file will be permanently deleted.
  - `created_by` object — The user who created this web link.
    - `id` string, required — The unique identifier for this user.
    - `type` 'user', required — The value will always be `user`.
    - `name` string — The display name of this user.
    - `login` string, email — The primary email address of this user.
  - `modified_by` object — The user who last modified this web link.
    - `id` string, required — The unique identifier for this user.
    - `type` 'user', required — The value will always be `user`.
    - `name` string — The display name of this user.
    - `login` string, email — The primary email address of this user.
  - `owned_by` object — The user who owns this web link.
    - `id` string, required — The unique identifier for this user.
    - `type` 'user', required — The value will always be `user`.
    - `name` string — The display name of this user.
    - `login` string, email — The primary email address of this user.
  - `shared_link` string, nullable — The shared link for this bookmark. This will be `null` if a bookmark has been trashed, since the link will no longer be active.
  - `item_status` 'active' | 'trashed' | 'deleted' — 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.

## Other responses

- `404` — Returns an error if the web link is not in the trash.
- `default` — An unexpected client error.

---

[API](https://skmtc.net/box/apis/platform-api.md) · [All operations](https://skmtc.net/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)