Sample - Box Platform API
GET/web_links/{web_link_id}/trash

Get trashed web link

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

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

2 parameters
web_link_idstringrequired
The ID of the web link.
fieldsarray<string>optional
A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response. Be aware that specifying this parameter will have the effect that none of the standard fields are returned in the response unless explicitly specified, instead only fields for the mini representation are returned, additional to the fields requested.

3 status codes
200Returns the web link that was trashed, including information about when the it was moved to the trash.
typestringoptional
The value will always be `web_link`.
Allowed:web_link
idstringoptional
The unique identifier for this web link.
sequence_idobjectoptional
etagstringoptional
The entity tag of this web link. Used with `If-Match` headers.
namestringoptional
The name of the web link.
urlstringoptional
The URL this web link points to.
parentobjectoptional
descriptionstringoptional
The description accompanying the web link. This is visible within the Box web application.
path_collectionobjectoptional
created_atstringoptional
When this file was created on Box’s servers.
modified_atstringoptional
When this file was last updated on the Box servers.
trashed_atstringoptional
When this file was last moved to the trash.
purged_atstringoptional
When this file will be permanently deleted.
created_byobjectoptional
modified_byobjectoptional
owned_byobjectoptional
shared_linkstringoptional
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_statusstringoptional
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.
Allowed:activetrasheddeleted
404Returns an error if the web link is not in the trash.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.
defaultAn unexpected client error.
typestringoptional
The value will always be `error`.
Allowed:error
statusintegeroptional
The HTTP status of the response.
codestringoptional
A Box-specific error code.
Allowed:createdacceptedno_contentredirectnot_modifiedbad_requestunauthorizedforbiddennot_foundmethod_not_allowedconflictprecondition_failed
messagestringoptional
A short message describing the error.
context_infoobjectoptional
A free-form object that contains additional context about the error. The possible fields are defined on a per-endpoint basis. `message` is only one example.
help_urlstringoptional
A URL that links to more information about why this error occurred.
request_idstringoptional
A unique identifier for this response, which can be used when contacting Box support.

Error handling

A 404 is returned: Returns an error if the web link is not in the trash. Any other status is an error: An unexpected client error.