Skip to main content
Classification labels are used for content that is sensitive or under security restrictions.

​
Classification

An instance of the classification metadata template, containing the classification applied to the file or folder. To get more details about the classification applied to an item, request the classification metadata template.
PropertyTypeRequiredDescription
Box__Security__Classification__KeystringNoThe name of the classification applied to the item.
$parentstringNoThe identifier of the item that this metadata instance has been attached to. This combines the type and the id of the parent in the form {type}_{id}.
$templateenum<string>NoThe value will always be securityClassification-6VMVochwUWo. Available options: securityClassification-6VMVochwUWo.
$scopestringNoThe scope of the enterprise that this classification has been applied for. This will be in the format enterprise_{enterprise_id}.
$versionintegerNoThe version of the metadata instance. This version starts at 0 and increases every time a classification is updated.
$typestringNoThe unique ID of this classification instance. This will be include the name of the classification template and a unique ID.
$typeVersionnumberNoThe version of the metadata template. This version starts at 0 and increases every time the template is updated. This is mostly for internal use.
$canEditbooleanNoWhether an end user can change the classification.
Example
{
  "Box__Security__Classification__Key": "Sensitive",
  "$parent": "folder_59449484661,",
  "$template": "securityClassification-6VMVochwUWo",
  "$scope": "enterprise_27335",
  "$version": 1,
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$canEdit": true
}

​
Classification Template

A metadata template that holds the security classifications defined by an enterprise.
PropertyTypeRequiredDescription
idstringYesThe ID of the classification template.
typeenum<string>YesThe value will always be metadata_template. Available options: metadata_template.
scopestringYesThe scope of the classification template. This is in the format enterprise_{id} where the id is the enterprise ID.
templateKeyenum<string>YesThe value will always be securityClassification-6VMVochwUWo. Available options: securityClassification-6VMVochwUWo.
displayNameenum<string>YesThe name of this template as shown in web and mobile interfaces. Available options: Classification.
hiddenbooleanNoDetermines if the template is always available in web and mobile interfaces.
copyInstanceOnItemCopybooleanNoDetermines if classifications are copied along when the file or folder is copied.
fieldsarray of objectYesA list of fields for this classification template. This includes only one field, the Box__Security__Classification__Key, which defines the different classifications available in this enterprise.
Example
{
  "id": "58063d82-4128-7b43-bba9-92f706befcdf",
  "type": "metadata_template",
  "scope": "enterprise_123456",
  "templateKey": "securityClassification-6VMVochwUWo",
  "displayName": "Classification",
  "hidden": false,
  "copyInstanceOnItemCopy": true,
  "fields": [
    {
      "id": "822227e0-47a5-921b-88a8-494760b2e6d2",
      "type": "enum",
      "key": "Box__Security__Classification__Key",
      "displayName": "Classification",
      "hidden": false,
      "options": [
        {
          "id": "46aea176-3483-4431-856c-6b5b13d1cc50",
          "key": "Sensitive",
          "staticConfig": {
            "classification": {
              "classificationDefinition": "Sensitive information",
              "colorID": 4
            }
          }
        }
      ]
    }
  ]
}
Last modified on July 9, 2026