Search File

Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Basic Parameters

Parameter	Description
Content Types	Limits the search results to any items that match the search query for a specific part of the file.
File Extensions	Limits the search results to any files that match any of the provided file extensions. This list is a comma-separated list of file extensions without the dots.
Query	The string to search for. This query is matched against item names, descriptions, text content of files, and various other fields of the different item types.
Type	Limits the search results to any items of this type.

Advanced Parameters

Parameter	Description
Ancestor Folder IDs	Limits the search results to items within the given list of folders, defined as a comma separated lists of folder IDs.
Created At End Date	Limits the search results to any items created within the given end date range.
Created At Start Date	Limits the search results to any items created within the given start date range.
Direction	Defines the direction in which search results are ordered.
Fields	A comma-separated list of attributes to include in the response. This can be used to request fields that are not normally returned in a standard response.
Limit	Defines the maximum number of items to return as part of a page of results.
Metadata filters	Limits the search results to any items for which the metadata matches the provided filter.
Offset	The offset of the item at which to begin the response.
Owner User IDs	Limits the search results to any items that are owned by the given list of owners, defined as a list of comma separated user IDs.
Recent Updater User IDs	Limits the search results to any items that have been updated by the given list of users, defined as a list of comma separated user IDs.
Scope	Limits the search results to either the files that the user has access to, or to files available to the entire enterprise.
Size Range	Limits the search results to any items with a size within a given file size range. This applied to files and folders.
Sort Order	Defines the order in which search results are returned.
Trash Content	Determines if the search should look in the trash for items.
Updated At End Date	Limits the search results to any items updated within the given end date range.
Updated At Start Date	Limits the search results to any items updated within the given start date range.

Example Output

{
    "entries": [
        {
            "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,
                    "can_edit": false
                },
                "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
}

Workflow Library Example

Search File with Box and Send Results Via Email

Preview this Workflow on desktop