Find web link for shared link
GET https://{{api.box.com}}/2.0/shared_items
Returns the web link represented by a shared link.
https://developer.box.com/reference/get-shared-items#web-links
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
fields | string | 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. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
if-none-match | number | Ensures an item is only returned if it has changed. |
Pass in the item's last observed etag value
into this header and the endpoint will fail
with a 304 Not Modified if the item has not
changed since. |
| boxapi | string | | A header containing the shared link and optional password for the
shared link.
The format for this header is as follows.
shared_link=[link]&shared_link_password=[password] |
RESPONSES
status: OK
{"id":"11446498","type":"web_link","etag":"1","url":"https://www.example.com/example/1234","sequence_id":"3","name":"My Bookmark","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":"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":{"url":"https://www.box.com/s/vspke7y05sb214wjokpk","download_url":"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg","vanity_url":"https://acme.app.box.com/v/my_url/","vanity_name":"my_url","access":"open","effective_access":"company","effective_permission":"can_download","unshared_at":"2018-04-13T13:53:23-07:00","is_password_enabled":true,"permissions":{"can_download":true,"can_preview":true,"can_edit":false},"download_count":3,"preview_count":3},"item_status":"active"}