Basic Parameters
| Parameter | Description |
|---|---|
| File ID | The unique identifier that represents a file. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Box API | The URL, and optional password, for the shared link of this item. This header can be used to access items that have not been explicitly shared with a user. Use the format shared_link=[link] or if a password is required then use shared_link=[link]&shared_link_password=[password]. |
| Ensure Item Has Changed | Ensures an item is only returned if it has changed. 0 - not changed, 1 - changed. |
| 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. |
| Representation Hints | A header required to request specific representations of a file. Use this in combination with the fields query parameter to request a specific file representation.For example, to request a png representation in 32x32 as well as 64x64 pixel dimensions provide the following hints: x-rep-hints: [jpg?dimensions=32x32][jpg?dimensions=64x64] |
Example Output
{
"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": [
{
"etag": "1",
"id": "12345",
"name": "Contracts",
"sequence_id": "3",
"type": "folder"
}
],
"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_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",
"type": "file"
}
Workflow Library Example
Get File Information with Box and Send Results Via Email