Folder (Base)

The bare basic representation of a folder, the minimal amount of fields returned when using the fields query parameter.

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

The fields that are part of the base variant represent the default fields that are always returned when using the fields query parameter, additional to the fields specified in the parameter.

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.

Response Example

{
  "id": "12345",
  "type": "folder",
  "etag": "1"
}