Skip to main content
A metadata instance describes the relation between a template and a file, including the values that are assigned for every field.

​
Metadata instance

An instance of a metadata template, which has been applied to a file or folder.
PropertyTypeRequiredDescription
$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}.
$templatestringNoThe name of the template.
$scopestringNoAn ID for the scope in which this template has been applied. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box.
$versionintegerNoThe version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.
Example
{
  "$parent": "folder_59449484661,",
  "$template": "marketingCollateral",
  "$scope": "enterprise_27335",
  "$version": 1
}

​
Metadata instance (Base)

The base representation of a metadata instance.
PropertyTypeRequiredDescription
$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}.
$templatestringNoThe name of the template.
$scopestringNoAn ID for the scope in which this template has been applied. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box.
$versionintegerNoThe version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.
Example
{
  "$parent": "folder_59449484661,",
  "$template": "marketingCollateral",
  "$scope": "enterprise_27335",
  "$version": 1
}

​
Metadata instance (Full)

An instance of a metadata template, which has been applied to a file or folder.
PropertyTypeRequiredDescription
$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}.
$templatestringNoThe name of the template.
$scopestringNoAn ID for the scope in which this template has been applied. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box.
$versionintegerNoThe version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.
$canEditbooleanNoWhether the user can edit this metadata instance.
$idstringNoA UUID to identify the metadata instance.
$typestringNoA unique identifier for the “type” of this instance. This is an internal system property and should not be used by a client application.
$typeVersionintegerNoThe last-known version of the template of the object. This is an internal system property and should not be used by a client application.
Example
{
  "$parent": "folder_59449484661,",
  "$template": "marketingCollateral",
  "$scope": "enterprise_27335",
  "$version": 1,
  "$canEdit": true,
  "$id": "01234500-12f1-1234-aa12-b1d234cb567e",
  "$type": "properties-6bcba49f-ca6d-4d2a-a758-57fe6edf44d0",
  "$typeVersion": 2
}

​
Metadata instances

A list of metadata instances that have been applied to a file or folder.
PropertyTypeRequiredDescription
entriesarray of Metadata instanceNoA list of metadata instances, as applied to this file or folder.
limitintegerNoThe limit that was used for this page of results.
Example
{
  "entries": [
    {
      "$parent": "folder_59449484661,",
      "$template": "marketingCollateral",
      "$scope": "enterprise_27335",
      "$version": 1
    }
  ],
  "limit": 100
}
Last modified on July 9, 2026