Join BoxWorks 2024 to discover what's possible with content and AI!

Folder (Mini)

A mini representation of a file version, used when nested under another resource.

This resource has a few variations that can be encountered when using the API.

The fields that are part of the mini variant are generally returned when the resource is nested within the response for another resource.

id string

example12345

The unique identifier that represent a folder.

The ID for any folder can be determined by visiting a folder in the web application and copying the ID from the URL. For example, for the URL https://*.app.box.com/folders/123 the folder_id is 123.

type string

examplefolder

folder

Value is always folder

etag string

example1

The HTTP etag of this folder. This can be used within some API endpoints in the If-Match and If-None-Match headers to only perform changes on the folder if (no) changes have happened.

name string

exampleContracts

The name of the folder.

sequence_id string

example3

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.

Response Example

{
  "id": "12345",
  "type": "folder",
  "etag": "1",
  "name": "Contracts",
  "sequence_id": "3"
}