A single of files, folder or web link that matched the search query, including the additional information about the shared link through which the item has been shared with the user. This response format is only returned when the `include_recent_shared_links` query parameter has been set to `true`.
The optional shared link through which the user has access to this item. This value is only returned for items for which the user has recently accessed the file through a shared link. For all other it
item
object
type
string
The result type. The value is always `search_result`.
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/SearchResultWithSharedLink",
"title": "Search Result (including Shared Link)",
"type": "object",
"x-box-resource-id": "search_result_with_shared_link",
"x-box-tag": "search",
"description": "A single of files, folder or web link that matched the search query,\nincluding the additional information about the shared link through\nwhich the item has been shared with the user.\n\nThis response format is only returned when the\n`include_recent_shared_links` query parameter has been set to `true`.",
"properties": {
"accessible_via_shared_link": {
"description": "The optional shared link through which the user has access to this\nitem. This value is only returned for items for which the user has\nrecently accessed the file through a shared link. For all other\nitems this value will return `null`.",
"example": "https://www.box.com/s/vspke7y05sb214wjokpk",
"type": "string",
"format": "url"
},
"item": {
"allOf": [
{
"oneOf": [
{
"$ref": "#/components/schemas/File--Full"
},
{
"$ref": "#/components/schemas/Folder--Full"
},
{
"$ref": "#/components/schemas/WebLink"
}
]
},
{
"description": "The file, folder or web link that matched the\nsearch query."
}
]
},
"type": {
"description": "The result type. The value is always `search_result`.",
"example": "search_result",
"type": "string"
}
}
}
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.