Box · Schema

Collection

A collection of items, including files and folders. Currently, the only collection available is the `favorites` collection. The contents of a collection can be explored in a similar way to which the contents of a folder is explored.

Cloud StorageCollaborationContent ManagementDocumentsEnterpriseFile Sharing

Properties

Name	Type	Description
id	string	The unique identifier for this collection.
type	string	`collection`
name	string	The name of the collection.
collection_type	string	The type of the collection. This is used to determine the proper visual treatment for collections.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Collection",
  "title": "Collection",
  "type": "object",
  "x-box-resource-id": "collection",
  "x-box-tag": "collections",
  "description": "A collection of items, including files and folders.\n\nCurrently, the only collection available\nis the `favorites` collection.\n\nThe contents of a collection can be explored in a\nsimilar way to which the contents of a folder is\nexplored.",
  "properties": {
    "id": {
      "type": "string",
      "description": "The unique identifier for this collection.",
      "example": "11446498"
    },
    "type": {
      "type": "string",
      "description": "`collection`",
      "example": "collection",
      "enum": [
        "collection"
      ]
    },
    "name": {
      "type": "string",
      "description": "The name of the collection.",
      "enum": [
        "Favorites"
      ],
      "example": "Favorites"
    },
    "collection_type": {
      "type": "string",
      "description": "The type of the collection. This is used to\ndetermine the proper visual treatment for\ncollections.",
      "enum": [
        "favorites"
      ],
      "example": "favorites"
    }
  }
}