Metadata query search result
A single file or folder that is returned for a metadata query, including its metadata that matched the query.
File (Standard) / Folder (Standard) object
A standard representation of a file or folder that matched the search query.
associative array
The metadata objects that matched the search query for the associated file or folder.
associative array
The key of the metadata template
Metadata instance object
A piece of metadata as specified by a metadata template and applied to a file or folder.
Response Example
{
"item": {
"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,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"description": "Contract for Q1 renewal",
"etag": 1,
"file_version": {
"id": 12345,
"sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc",
"type": "file_version"
},
"id": 12345,
"item_status": "active",
"modified_at": "2012-12-12T10:53:43-08:00",
"modified_by": {
"id": 11446498,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"name": "Contract.pdf",
"owned_by": {
"id": 11446498,
"login": "ceo@example.com",
"name": "Aaron Levie",
"type": "user"
},
"parent": {
"etag": 1,
"id": 12345,
"name": "Contracts",
"sequence_id": 3,
"type": "folder"
},
"path_collection": {
"entries": [
{
"id": 12345,
"etag": 1,
"type": "folder",
"sequence_id": 3,
"name": "Contracts"
}
],
"total_count": 1
},
"purged_at": "2012-12-12T10:53:43-08:00",
"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_preview": true
},
"preview_count": 3,
"unshared_at": "2018-04-13T13:53:23-07:00",
"url": "https://www.box.com/s/vspke7y05sb214wjokpk",
"vanity_url": "https://acme.app.box.com/v/my_url/"
},
"size": 629644,
"trashed_at": "2012-12-12T10:53:43-08:00",
"type": "file"
},
"metadata": {
"enterprise_27335": {
"marketingCollateral": {
"$canEdit": true,
"$id": "01234500-12f1-1234-aa12-b1d234cb567e",
"$parent": "folder_59449484661",
"$scope": "enterprise_27335",
"$template": "properties",
"$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
"$typeVersion": 2,
"$version": 1
}
}
}
}