Box Developer Documentation
Log in

Search Result (including Shared Link)

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.

string
search_result

The result type. The value is always search_result.

string (url)
https://www.box.com/s/vspke7y05sb214wjokpk

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 items this value will return null.

File (Full) / Folder (Full) / Web link object

The file, folder or web link that matched the search query.

Response Example

{
  "type": "search_result",
  "accessible_via_shared_link": "https://www.box.com/s/vspke7y05sb214wjokpk",
  "item": {
    "id": "12345",
    "type": "file",
    "allowed_invitee_roles": [
      "editor"
    ],
    "classification": {
      "color": "#FF0000",
      "definition": "Content that should not be shared outside the company.",
      "name": "Top Secret"
    },
    "comment_count": 10,
    "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": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "description": "Contract for Q1 renewal",
    "disposition_at": "2012-12-12T10:53:43-08:00",
    "etag": "1",
    "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",
    "file_version": {
      "id": "12345",
      "type": "file_version",
      "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
    },
    "has_collaborations": true,
    "is_accessible_via_shared_link": true,
    "is_associated_with_app_item": true,
    "is_externally_owned": true,
    "is_package": true,
    "item_status": "active",
    "lock": {
      "id": "11446498",
      "type": "lock",
      "app_type": "office_wopiplus",
      "created_at": "2012-12-12T10:53:43-08:00",
      "created_by": {
        "id": "11446498",
        "type": "user",
        "login": "ceo@example.com",
        "name": "Aaron Levie"
      },
      "expired_at": "2012-12-12T10:53:43-08:00",
      "is_download_prevented": true
    },
    "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
        }
      }
    },
    "modified_at": "2012-12-12T10:53:43-08:00",
    "modified_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "name": "Contract.pdf",
    "owned_by": {
      "id": "11446498",
      "type": "user",
      "login": "ceo@example.com",
      "name": "Aaron Levie"
    },
    "parent": {
      "id": "12345",
      "type": "folder",
      "etag": "1",
      "name": "Contracts",
      "sequence_id": "3"
    },
    "path_collection": {
      "entries": [
        {
          "etag": "1",
          "id": "12345",
          "type": "folder",
          "name": "Contracts",
          "sequence_id": "3"
        }
      ],
      "total_count": 1
    },
    "permissions": {
      "can_annotate": true,
      "can_comment": true,
      "can_delete": true,
      "can_download": true,
      "can_invite_collaborator": true,
      "can_preview": true,
      "can_rename": true,
      "can_set_share_access": true,
      "can_share": true,
      "can_upload": true,
      "can_view_annotations_all": true,
      "can_view_annotations_self": true
    },
    "purged_at": "2012-12-12T10:53:43-08:00",
    "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"
          }
        }
      ]
    },
    "sequence_id": "3",
    "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
    "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/"
    },
    "shared_link_permission_options": [
      "can_preview"
    ],
    "size": 629644,
    "tags": [
      "approved"
    ],
    "trashed_at": "2012-12-12T10:53:43-08:00",
    "uploader_display_name": "Ellis Wiggins",
    "version_number": "1",
    "watermark_info": {
      "is_watermarked": true
    }
  }
}