Items

A list of files, folders, and web links in their mini representation.

object array

The items in this collection.

11446498

The unique identifier for this item

file

The type of this item

Value is one of file,folder,web_link

1

The entity tag of this item. Used with If-Match headers. May be null for some folders such as root or trash.

The information about the current version of the file. This is only returned for items of type file.

12345

The unique identifier that represent a file version.

file_version

Value is always file_version

134b65991ed521fcfe4724b7d814ab8ded5185dc

The SHA1 hash of this version of the file.

Pictures

The name of the item.

3

A numeric identifier that represents the most recent user event that has been applied to this item.

This can be used in combination with the GET /events-endpoint to filter out user events that would have occurred before this identifier was read.

An example would be where a Box Drive-like application would fetch an item via the API, and then listen to incoming user events for changes to the item. The application would ignore any user events where the sequence_id in the event is smaller than or equal to the sequence_id in the originally fetched resource.

string / digest
85136C79CBF9FE36BB9D05D0639C70C265C18D37

The SHA1 hash of the item. This can be used to compare the contents of a file or web link with another item.

https://www.example.com/example/1234

The URL this item points to. This is only returned for items of type web_link.

integer / int64
1000

The limit that was used for these entries. This will be the same as the limit query parameter unless that value exceeded the maximum value allowed. The maximum value varies by API.

integer / int64
2000

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

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

object array

The order by which items are returned.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

string
type

The field to order by

ASC

The direction to order by, either ascending or descending

Value is one of ASC,DESC

integer / int64
5000

One greater than the offset of the last entry in the entire collection. The total number of entries in the collection may be less than total_count.

This field is only returned for calls that use offset-based pagination. For marker-based paginated APIs, this field will be omitted.

Response Example

{
  "entries": [
    {
      "id": 11446498,
      "type": "file",
      "sequence_id": 3,
      "etag": 1,
      "name": "Pictures",
      "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
      "file_version": {
        "id": 12345,
        "type": "file_version",
        "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
      },
      "url": "https://www.example.com/example/1234"
    }
  ],
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "total_count": 5000
}