Folder

A standard representation of a folder, as returned from any folder API endpoints by default

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

The fields that are part of the standard variant are generally returned when the resource is requested via its own API endpoints. For example, when retrieving a file by ID, it will return these fields unless the fields parameter has been specified.

id string

example"12345"

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

example"folder"

folder

Value is always folder

content_created_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time at which this folder was originally created.

content_modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time at which this folder was last updated.

created_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time when the folder was created. This value may be null for some folders such as the root folder or the trash folder.

created_byUser (Mini) object

The user who created this folder

description string

example"Legal contracts for the new ACME deal"max length256

The optional description of this folder

etag string

example"1"

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.

folder_upload_email object

folder_upload_email.access string

example"open"

When this parameter has been set, users can email files to the email address that has been automatically created for this folder.

To create an email address, set this property either when creating or updating the folder.

When set to collaborators, only emails from registered email addresses for collaborators will be accepted. This includes any email aliases a user might have registered.

When set to open it will accept emails from any email address.

Value is one of open,collaborators

folder_upload_email.email string / email

example"upload.Contracts.asd7asd@u.box.com"

The optional upload email address for this folder.

item_collectionItems object

A page of the items that are in the folder.

This field can only be requested when querying a folder's information, not when querying a folder's items.

item_status string

example"active"

Defines if this item has been deleted or not.

active when the item has is not in the trash
trashed when the item has been moved to the trash but not deleted
deleted when the item has been permanently deleted.

Value is one of active,trashed,deleted

modified_at string / date-time

example"2012-12-12T10:53:43-08:00"

The date and time when the folder was last updated. This value may be null for some folders such as the root folder or the trash folder.

modified_byUser (Mini) object

The user who last modified this folder.

name string

example"Contracts"

The name of the folder.

owned_byUser (Mini) object

The user who owns this folder.

parentFolder (Mini) object

The optional folder that this folder is located within.

This value may be null for some folders such as the root folder or the trash folder.

path_collection object

The tree of folders that this folder is contained in, starting at the root.

path_collection.entriesFolder (Mini) array

The parent folders for this item

path_collection.total_count integer / int64

example1

The number of folders in this list.

purged_at string / date-time

example"2012-12-12T10:53:43-08:00"

The time at which this folder is expected to be purged from the trash.

sequence_id string

example"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.

shared_link object

The shared link for this folder. This will be null if no shared link has been created for this folder.

shared_link.access string

example"open"

The access level for this shared link.

open - provides access to this item to anyone with this link
company - only provides access to this item to people the same company
collaborators - only provides access to this item to people who are collaborators on this item

If this field is omitted when creating the shared link, the access level will be set to the default access level specified by the enterprise admin.

Value is one of open,company,collaborators

shared_link.download_count integer

example3

The number of times this item has been downloaded.

shared_link.download_url string / url

example"https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg"

A URL that can be used to download the file. This URL can be used in a browser to download the file. This URL includes the file extension so that the file will be saved with the right file type.

This property will be null for folders.

shared_link.effective_access string

example"company"

The effective access level for the shared link. This can be a more restrictive access level than the value in the access field when the enterprise settings restrict the allowed access levels.

Value is one of open,company,collaborators

shared_link.effective_permission string

example"can_download"

The effective permissions for this shared link. These result in the more restrictive combination of the share link permissions and the item permissions set by the administrator, the owner, and any ancestor item such as a folder.

Value is one of can_edit,can_download,can_preview,no_access

shared_link.is_password_enabled boolean

exampletrue

Defines if the shared link requires a password to access the item.

shared_link.permissions object

Defines if this link allows a user to preview, edit, and download an item. These permissions refer to the shared link only and do not supersede permissions applied to the item itself.

permissions.can_download boolean

exampletrue

Defines if the shared link allows for the item to be downloaded. For shared links on folders, this also applies to any items in the folder.

This value can be set to true when the effective access level is set to open or company, not collaborators.

permissions.can_edit boolean

examplefalse

Defines if the shared link allows for the item to be edited.

This value can only be true if can_download is also true and if the item has a type of file.

permissions.can_preview boolean

exampletrue

Defines if the shared link allows for the item to be previewed.

This value is always true. For shared links on folders this also applies to any items in the folder.

shared_link.preview_count integer

example3

The number of times this item has been previewed.

shared_link.unshared_at string / date-time

example"2018-04-13T13:53:23-07:00"

The date and time when this link will be unshared. This field can only be set by users with paid accounts.

shared_link.url string / url

example"https://www.box.com/s/vspke7y05sb214wjokpk"

The URL that can be used to access the item on Box.

This URL will display the item in Box's preview UI where the file can be downloaded if allowed.

This URL will continue to work even when a custom vanity_url has been set for this shared link.

shared_link.vanity_name string

example"my_url"

The custom name of a shared link, as used in the vanity_url field.

shared_link.vanity_url string / url

example"https://acme.app.box.com/v/my_url/"

The "Custom URL" that can also be used to preview the item on Box. Custom URLs can only be created or modified in the Box Web application.

size integer / int64

example629644

The folder size in bytes.

Be careful parsing this integer as its value can get very large.

trashed_at string / date-time

example"2012-12-12T10:53:43-08:00"

The time at which this folder was put in the trash.

Response Example

{
  "id": "12345",
  "type": "folder",
  "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",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "description": "Legal contracts for the new ACME deal",
  "etag": "1",
  "folder_upload_email": {
    "access": "open",
    "email": "upload.Contracts.asd7asd@u.box.com"
  },
  "item_collection": {
    "entries": [
      {
        "id": "12345",
        "etag": "1",
        "type": "file",
        "sequence_id": "3",
        "name": "Contract.pdf",
        "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
        "file_version": {
          "id": "12345",
          "type": "file_version",
          "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
        },
        "description": "Contract for Q1 renewal",
        "size": 629644,
        "path_collection": {
          "total_count": 1,
          "entries": [
            {
              "id": "12345",
              "etag": "1",
              "type": "folder",
              "sequence_id": "3",
              "name": "Contracts"
            }
          ]
        },
        "created_at": "2012-12-12T10:53:43-08:00",
        "modified_at": "2012-12-12T10:53:43-08:00",
        "trashed_at": "2012-12-12T10:53:43-08:00",
        "purged_at": "2012-12-12T10:53:43-08:00",
        "content_created_at": "2012-12-12T10:53:43-08:00",
        "content_modified_at": "2012-12-12T10:53:43-08:00",
        "created_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "modified_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "owned_by": {
          "id": "11446498",
          "type": "user",
          "name": "Aaron Levie",
          "login": "ceo@example.com"
        },
        "shared_link": {
          "url": "https://www.box.com/s/vspke7y05sb214wjokpk",
          "download_url": "https://www.box.com/shared/static/rh935iit6ewrmw0unyul.jpeg",
          "vanity_url": "https://acme.app.box.com/v/my_url/",
          "vanity_name": "my_url",
          "access": "open",
          "effective_access": "company",
          "effective_permission": "can_download",
          "unshared_at": "2018-04-13T13:53:23-07:00",
          "is_password_enabled": true,
          "permissions": {
            "can_download": true,
            "can_preview": true,
            "can_edit": false
          },
          "download_count": 3,
          "preview_count": 3
        },
        "parent": {
          "id": "12345",
          "etag": "1",
          "type": "folder",
          "sequence_id": "3",
          "name": "Contracts"
        },
        "item_status": "active",
        "version_number": "1",
        "comment_count": 10,
        "permissions": {
          "can_delete": true,
          "can_download": true,
          "can_invite_collaborator": true,
          "can_rename": true,
          "can_set_share_access": true,
          "can_share": true,
          "can_annotate": true,
          "can_comment": true,
          "can_preview": true,
          "can_upload": true,
          "can_view_annotations_all": true,
          "can_view_annotations_self": true
        },
        "tags": [
          "approved"
        ],
        "lock": {
          "id": "11446498",
          "type": "lock",
          "created_by": {
            "id": "11446498",
            "type": "user",
            "name": "Aaron Levie",
            "login": "ceo@example.com"
          },
          "created_at": "2012-12-12T10:53:43-08:00",
          "expired_at": "2012-12-12T10:53:43-08:00",
          "is_download_prevented": true,
          "app_type": "office_wopiplus"
        },
        "extension": "pdf",
        "is_package": true,
        "expiring_embed_link": {
          "access_token": "c3FIOG9vSGV4VHo4QzAyg5T1JvNnJoZ3ExaVNyQWw6WjRsanRKZG5lQk9qUE1BVQ",
          "expires_in": 3600,
          "token_type": "bearer",
          "restricted_to": [
            {
              "scope": "item_download",
              "object": {
                "id": "12345",
                "etag": "1",
                "type": "file",
                "sequence_id": "3",
                "name": "Contract.pdf",
                "sha1": "85136C79CBF9FE36BB9D05D0639C70C265C18D37",
                "file_version": {
                  "id": "12345",
                  "type": "file_version",
                  "sha1": "134b65991ed521fcfe4724b7d814ab8ded5185dc"
                }
              }
            }
          ],
          "url": "https://cloud.app.box.com/preview/expiring_embed/..."
        },
        "watermark_info": {
          "is_watermarked": true
        },
        "is_accessible_via_shared_link": true,
        "allowed_invitee_roles": [
          "editor"
        ],
        "is_externally_owned": true,
        "has_collaborations": true,
        "metadata": {
          "enterprise_27335": {
            "marketingCollateral": {
              "$canEdit": true,
              "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
              "$parent": "folder_59449484661",
              "$scope": "enterprise_27335",
              "$template": "marketingCollateral",
              "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
              "$typeVersion": 2,
              "$version": 1
            }
          }
        },
        "expires_at": "2012-12-12T10:53:43-08:00",
        "representations": {
          "entries": [
            {
              "content": {
                "url_template": "https://dl.boxcloud.com/api/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048/content/{+asset_path}?watermark_content=4567"
              },
              "info": {
                "url": "https://api.box.com/2.0/internal_files/123/versions/345/representations/png_paged_2048x2048"
              },
              "properties": {
                "dimensions": "2048x2048",
                "paged": true,
                "thumb": true
              },
              "representation": "png",
              "status": {
                "state": "success"
              }
            }
          ]
        },
        "classification": {
          "name": "Top Secret",
          "definition": "Content that should not be shared outside the company.",
          "color": "#FF0000"
        },
        "uploader_display_name": "Ellis Wiggins",
        "disposition_at": "2012-12-12T10:53:43-08:00",
        "shared_link_permission_options": [
          "can_preview"
        ]
      }
    ],
    "limit": 1000,
    "offset": 2000,
    "order": [
      {
        "by": "type",
        "direction": "ASC"
      }
    ],
    "total_count": 5000
  },
  "item_status": "active",
  "modified_at": "2012-12-12T10:53:43-08:00",
  "modified_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "name": "Contracts",
  "owned_by": {
    "id": "11446498",
    "type": "user",
    "login": "ceo@example.com",
    "name": "Aaron Levie"
  },
  "parent": {
    "id": "12345",
    "type": "folder",
    "etag": "1",
    "name": "Contracts",
    "sequence_id": "3"
  },
  "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",
  "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"
}