Skip to main content
API version 2024.0 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.
​
$canEdit
boolean
example: trueWhether an end user can change the classification.
​
$parent
string
example: folder_59449484661,The 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}.
​
$scope
string
example: enterprise_27335The scope of the enterprise that this classification has been applied for.This will be in the format enterprise_{enterprise_id}.
​
$template
string
example: securityClassification-6VMVochwUWoThe value will always be securityClassification-6VMVochwUWo.Value is always securityClassification-6VMVochwUWo
​
$type
string
example: securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8The unique ID of this classification instance. This will be include the name of the classification template and a unique ID.
​
$typeVersion
number
example: 5The version of the metadata template. This version starts at 0 and increases every time the template is updated. This is mostly for internal use.
​
$version
integer
example: 1The version of the metadata instance. This version starts at 0 and increases every time a classification is updated.
​
Box__Security__Classification__Key
string
example: SensitiveThe name of the classification applied to the item.
{
  "$canEdit": true,
  "$parent": "folder_59449484661,",
  "$scope": "enterprise_27335",
  "$template": "securityClassification-6VMVochwUWo",
  "$type": "securityClassification-6VMVochwUWo-fd31537a-0f95-4d86-9f2b-5974a29978f8",
  "$typeVersion": 5,
  "$version": 1,
  "Box__Security__Classification__Key": "Sensitive"
}