Search Results (including Shared Links)

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.

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.

integer / int64
1000

The 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.

integer / int64
2000

The 0-based offset of the first entry in this set. This will be the same as the offset query parameter used.

integer / int64
5000

One 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.

Response Example

{
  "entries": [
    {
      "accessible_via_shared_link": "https://www.box.com/s/vspke7y05sb214wjokpk",
      "item": {
        "id": 12345,
        "etag": 1,
        "type": "file",
        "sequence_id": 3,
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": 12345,
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "description": "Contract for Q1 renewal",
        "size": 629644,
        "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",
        "content_created_at": "2012-12-12T10:53:43-08:00",
        "content_modified_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
          },
          "download_count": 3,
          "preview_count": 3
        },
        "parent": {
          "id": 12345,
          "etag": 1,
          "type": "folder",
          "sequence_id": 3,
          "name": "Contracts"
        },
        "item_status": "active"
      }
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "total_count": 5000
}