---
title: "Get metadata instance on folder"
method: GET
path: "/folders/{folder_id}/metadata/{scope}/{template_key}"
tags: ["Metadata instances (Folders)"]
---

# Get metadata instance on folder

`GET /folders/{folder_id}/metadata/{scope}/{template_key}`

Retrieves the instance of a metadata template that has been applied to a
folder. This can not be used on the root folder with ID `0`.

## Path parameters

- `folder_id` string, required
- `scope` 'global' | 'enterprise', required
- `template_key` string, required

## Response `201`

An instance of the metadata template that includes
additional "key:value" pairs defined by the user or
an application.

- MetadataFull — The base representation of a metadata instance.
  - `$parent` string — 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}`.
  - `$template` string — The name of the template.
  - `$scope` string — An 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.
  - `$version` integer — The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.
  - `$canEdit` boolean — Whether the user can edit this metadata instance.
  - `$id` string, uuid — A UUID to identify the metadata instance.
  - `$type` string — A unique identifier for the "type" of this instance. This is an internal system property and should not be used by a client application.
  - `$typeVersion` integer — The last-known version of the template of the object. This is an internal system property and should not be used by a client application.

## Other responses

- `403` — Returned when the request parameters are not valid.
- `404` — Returned if the metadata template specified was not applied to this folder or the user does not have access to the folder. * `instance_not_found` - The metadata template was not applied to the folder.
- `405` — Returned when the method was not allowed. This often happens when the folder ID is not valid or the root folder with ID `0`.
- `default` — An unexpected client error.

---

[API](https://skmtc.dev/box/apis/platform-api.md) · [All operations](https://skmtc.dev/box/apis/platform-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/box/platform-api/revisions/ba8f087e1a4d/schema)