Box Developer Documentation
Log in
Latest version

Find app item for shared link

get
https://api.box.com/2.0
/shared_items

This endpoint is in the version 2024.0. No changes are required to continue using it. For more details, see Box API versioning.

Returns the app item represented by a shared link.

The link can originate from the current enterprise or another.

Request

bearer [ACCESS_TOKEN]
application/json

Request Headers

stringin headerrequired
shared_link=[example.com]&shared_link_password=[xyz123]

A header containing the shared link and optional password for the shared link.

The format for this header is shared_link=[link]&shared_link_password=[password].

Response

application/jsonApp item

Returns a full app item resource if the shared link is valid and the user has access to it.

application/jsonClient error

An unexpected client error.

get
Find app item for shared link
You can now try out some of our APIs live, right here in the documentation.
Log in

Request Example

Learn more about Box SDK versionig strategy.


Node/TypeScript v10
await client.sharedLinksAppItems.findAppItemForSharedLink({
  boxapi: ''.concat('shared_link=', appItemSharedLink) as string,
} satisfies FindAppItemForSharedLinkHeadersInput);
Python v10
client.shared_links_app_items.find_app_item_for_shared_link(
    "".join(["shared_link=", app_item_shared_link])
)
.NET v10
await client.SharedLinksAppItems.FindAppItemForSharedLinkAsync(headers: new FindAppItemForSharedLinkHeaders(boxapi: string.Concat("shared_link=", appItemSharedLink)));
Swift v10
try await client.sharedLinksAppItems.findAppItemForSharedLink(headers: FindAppItemForSharedLinkHeaders(boxapi: "\("shared_link=")\(appItemSharedLink)"))
Java v10
client.getSharedLinksAppItems().findAppItemForSharedLink(new FindAppItemForSharedLinkHeaders(String.join("", "shared_link=", appItemSharedLink)))

Response Example

{
  "id": "12345678",
  "type": "app_item",
  "application_type": "hubs"
}