Skip to main content
API version 2024.0 A list of files, folders and web links that matched the search query, including the additional information about any shared links 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.
​
type
string
example: search_results_with_shared_linksSpecifies the response as search result items with shared links.Value is always search_results_with_shared_links
​
entries
Search Result (including Shared Link)array
The search results for the query provided, including the additional information about any shared links through which the item has been shared with the user.
​
limit
integer(int64)
example: 1000The limit that was used for this search. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed.
​
offset
integer(int64)
example: 2000The 0-based offset of the first entry in this set. This will be the same as the offset query parameter used.
​
total_count
integer(int64)
example: 5000One greater than the offset of the last entry in the search results. The total number of entries in the collection may be less than total_count.
{
  "type": "search_results_with_shared_links",
  "entries": [
    {
      "accessible_via_shared_link": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "item": {
        "etag": "1",
        "id": "12345",
        "type": "file",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "name": "Contract.pdf",
        "sequence_id": "3",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "content_created_at": "2012-12-12T10:53:43-08:00",
        "content_modified_at": "2012-12-12T10:53:43-08:00",
        "created_at": "2012-12-12T10:53:43-08:00",
        "created_by": {
          "id": "11446498",
          "type": "user",
          "login": "[email protected]",
          "name": "Aaron Levie"
        },
        "description": "Contract for Q1 renewal",
        "item_status": "active",
        "modified_at": "2012-12-12T10:53:43-08:00",
        "modified_by": {
          "id": "11446498",
          "type": "user",
          "login": "[email protected]",
          "name": "Aaron Levie"
        },
        "owned_by": {
          "id": "11446498",
          "type": "user",
          "login": "[email protected]",
          "name": "Aaron Levie"
        },
        "parent": {
          "etag": "1",
          "id": "12345",
          "type": "folder",
          "name": "Contracts",
          "sequence_id": "3"
        },
        "path_collection": {
          "entries": [
            {
              "etag": "1",
              "id": "12345",
              "type": "folder",
              "name": "Contracts",
              "sequence_id": "3"
            }
          ],
          "total_count": 1
        },
        "purged_at": "2012-12-12T10:53:43-08:00",
        "shared_link": {
          "access": "open",
          "download_count": 3,
          "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
          "effective_access": "company",
          "effective_permission": "can_download",
          "is_password_enabled": true,
          "permissions": {
            "can_download": true,
            "can_edit": false,
            "can_preview": true
          },
          "preview_count": 3,
          "unshared_at": "2018-04-13T13:53:23-07:00",
          "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
          "vanity_name": "my_url",
          "vanity_url": "https://acme.app.box.com/v/my_url/"
        },
        "size": 629644,
        "trashed_at": "2012-12-12T10:53:43-08:00",
        "allowed_invitee_roles": [
          "editor"
        ],
        "classification": {
          "color": "#FF0000",
          "definition": "Content that should not be shared outside the company.",
          "name": "Top Secret"
        },
        "comment_count": 10,
        "disposition_at": "2012-12-12T10:53:43-08:00",
        "expires_at": "2012-12-12T10:53:43-08:00",
        "expiring_embed_link": {
          "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
          "expires_in": 3600,
          "restricted_to": [
            {
              "object": {
                "etag": "1",
                "id": "12345",
                "type": "folder",
                "name": "Contracts",
                "sequence_id": "3"
              },
              "scope": "item_download"
            }
          ],
          "token_type": "bearer",
          "url": "https://cloud.app.box.com/preview/expiring_embed/..."
        },
        "extension": "pdf",
        "has_collaborations": true,
        "is_accessible_via_shared_link": true,
        "is_associated_with_app_item": true,
        "is_externally_owned": true,
        "is_package": true,
        "lock": {
          "app_type": "office_wopiplus",
          "created_at": "2012-12-12T10:53:43-08:00",
          "created_by": {
            "id": "11446498",
            "type": "user",
            "login": "[email protected]",
            "name": "Aaron Levie"
          },
          "expired_at": "2012-12-12T10:53:43-08:00",
          "id": "11446498",
          "is_download_prevented": true,
          "type": "lock"
        },
        "metadata": {
          "enterprise_27335": {
            "marketingCollateral": {
              "$canEdit": true,
              "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
              "$parent": "folder_59449484661",
              "$scope": "enterprise_27335",
              "$template": "marketingCollateral",
              "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
              "$typeVersion": 2,
              "$version": 1
            }
          }
        },
        "permissions": {
          "can_delete": true,
          "can_download": true,
          "can_invite_collaborator": true,
          "can_rename": true,
          "can_set_share_access": true,
          "can_share": true,
          "can_annotate": true,
          "can_comment": true,
          "can_preview": true,
          "can_upload": true,
          "can_view_annotations_all": true,
          "can_view_annotations_self": true
        },
        "representations": {
          "entries": [
            {
              "content": {
                "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"
              },
              "info": {
                "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"
              },
              "properties": {
                "dimensions": "2048x2048",
                "paged": "true",
                "thumb": "true"
              },
              "representation": "png",
              "status": {
                "state": "success"
              }
            }
          ]
        },
        "shared_link_permission_options": [
          "can_preview"
        ],
        "tags": [
          "approved"
        ],
        "uploader_display_name": "Ellis Wiggins",
        "version_number": "1",
        "watermark_info": {
          "is_watermarked": true
        }
      },
      "type": "search_result"
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}