> ## Documentation Index
> Fetch the complete documentation index at: https://developer.box.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get metadata on item

export const MultiRelatedLinks = ({sections = []}) => {
  if (!sections || sections.length === 0) {
    return null;
  }
  return <div className="space-y-8">
      {sections.map((section, index) => <RelatedLinks key={index} title={section.title} items={section.items} />)}
    </div>;
};

export const RelatedLinks = ({title, items = []}) => {
  const getBadgeClass = badge => {
    if (!badge) return "badge-default";
    const badgeType = badge.toLowerCase().replace(/\s+/g, "-");
    return `badge-${badge === "ガイド" ? "guide" : badgeType}`;
  };
  if (!items || items.length === 0) {
    return null;
  }
  return <div className="my-8">
      {}
      <h3 className="text-sm font-bold uppercase tracking-wider mb-4">{title}</h3>

      {}
      <div className="flex flex-col gap-3">
        {items.map((item, index) => <a key={index} href={item.href} className="py-2 px-3 rounded related_link hover:bg-[#f2f2f2] dark:hover:bg-[#111827] flex items-center gap-3 group no-underline hover:no-underline border-b-0">
            {}
            <span className={`px-2 py-1 rounded-full text-xs font-semibold uppercase tracking-wide flex-shrink-0 ${getBadgeClass(item.badge)}`}>
              {item.badge}
            </span>

            {}
            <span className="text-base">{item.label}</span>
          </a>)}
      </div>
    </div>;
};

export const Link = ({href, children, className, ...props}) => {
  const localizedHref = href;
  return <a href={localizedHref} className={className} {...props}>
      {children}
    </a>;
};

Information about an instance of a metadata template assigned to a file or
folder can be retrieved using the item's `id`, and the template's `templateKey`
and `scope`.

<Info>
  Metadata <Link href="/guides/metadata/scopes">scopes</Link> can be either `global` for templates available to
  all enterprises, `enterprise` for templates available to the current
  enterprise, or the `enterprise_:id` for templates belonging to an enterprise
  whose ID is the `:id` value in the scope name.
</Info>

## Get metadata instance on file

To get an instance of a metadata template on a file, call the
<Link href="/reference/get-files-id-metadata-id-id">`GET /files/:file_id/metadata/:scope/:templateKey`</Link> API endpoint
with the file's `file_id` and the template's `scope` and `templateKey`.

<CodeGroup>
  ```sh cURL theme={null}
  curl -i -X GET "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
       -H "authorization: Bearer <ACCESS_TOKEN>"
  ```

  ```typescript Node/TypeScript v10 theme={null}
  await client.fileMetadata.getFileMetadataById(
    file.id,
    'global' as GetFileMetadataByIdScope,
    'properties',
  );
  ```

  ```python Python v10 theme={null}
  client.file_metadata.get_file_metadata_by_id(
      file.id, GetFileMetadataByIdScope.GLOBAL, "properties"
  )
  ```

  ```csharp .NET v10 theme={null}
  await client.FileMetadata.GetFileMetadataByIdAsync(fileId: file.Id, scope: GetFileMetadataByIdScope.Global, templateKey: "properties");
  ```

  ```swift Swift v10 theme={null}
  try await client.fileMetadata.getFileMetadataById(fileId: file.id, scope: GetFileMetadataByIdScope.global, templateKey: "properties")
  ```

  ```java Java v10 theme={null}
  client.getFileMetadata().getFileMetadataById(file.getId(), GetFileMetadataByIdScope.GLOBAL, "properties")
  ```

  ```java Java v5 theme={null}
  // Get the default free-form metadata properties
  BoxFile file = new BoxFile(api, "id");
  Metadata metadata = file.getMetadata();

  // Unknown type metadata field, you can test for type or try to get as any type
  JsonValue unknownValue = metadata.getValue("/someField");

  // String or Enum metadata fields
  String stringValue = metadata.getString("/author");

  // Float metadata fields can be interpreted as any numeric type
  float floatValue = metadata.getFloat("/price");

  // Date metadata fields
  Date dateValue = metadata.getDate("/deadline");

  // Multiselect metadata fields
  List<String> multiSelectValues = metadata.getMultiSelect("/categories");
  ```

  ```py Python v4 theme={null}
  metadata = client.file(file_id='11111').metadata(scope='enterprise', template='myMetadata').get()
  print(f'Got metadata instance {metadata["$id"]}')
  ```

  ```csharp .NET v6 theme={null}
  Dictionary<string, object> metadata = await client.MetadataManager.
      .GetFileMetadataAsync(fileId: "11111", "enterprise", "marketingCollateral");
  ```

  ```js Node v4 theme={null}
  client.files.getMetadata('11111', client.metadata.scopes.ENTERPRISE, 'marketingCollateral')
   .then(metadata => {
    /* metadata -> {
     audience: 'internal',
     documentType: 'Q1 plans',
     competitiveDocument: 'no',
     status: 'active',
     author: 'Jones',
     currentState: 'proposal',
     '$type': 'marketingCollateral-d086c908-2498-4d3e-8a1f-01e82bfc2abe',
     '$parent': 'file_11111',
     '$id': '2094c584-68e1-475c-a581-534a4609594e',
     '$version': 0,
     '$typeVersion': 0,
     '$template': 'marketingCollateral',
     '$scope': 'enterprise_12345' }
    */
   });
  ```
</CodeGroup>

<Info>
  To get the `scope` and `templateKey` for a template, either
  <Link href="/guides/metadata/templates/list">list all metadata templates</Link>, or
  <Link href="/guides/metadata/instances/list">list all instances on an file</Link>.
</Info>

## Get metadata instance on folder

To get an instance of a metadata template on a folder, call the
<Link href="/reference/get-files-id-metadata-id-id">`GET /folders/:folder_id/metadata/:scope/:templateKey`</Link> API endpoint
with the folder's `folder_id` and the template's `scope` and `templateKey`.

<CodeGroup>
  ```sh cURL theme={null}
  curl -i -X GET "https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate" \
       -H "authorization: Bearer <ACCESS_TOKEN>"
  ```

  ```typescript Node/TypeScript v10 theme={null}
  await client.folderMetadata.getFolderMetadataById(
    folder.id,
    'global' as GetFolderMetadataByIdScope,
    'properties',
  );
  ```

  ```python Python v10 theme={null}
  client.folder_metadata.get_folder_metadata_by_id(
      folder.id, GetFolderMetadataByIdScope.GLOBAL, "properties"
  )
  ```

  ```csharp .NET v10 theme={null}
  await client.FolderMetadata.GetFolderMetadataByIdAsync(folderId: folder.Id, scope: GetFolderMetadataByIdScope.Global, templateKey: "properties");
  ```

  ```swift Swift v10 theme={null}
  try await client.folderMetadata.getFolderMetadataById(folderId: folder.id, scope: GetFolderMetadataByIdScope.global, templateKey: "properties")
  ```

  ```java Java v10 theme={null}
  client.getFolderMetadata().getFolderMetadataById(folder.getId(), GetFolderMetadataByIdScope.GLOBAL, "properties")
  ```

  ```java Java v5 theme={null}
  BoxFolder folder = new BoxFolder(api, "id");
  Metadata metadata = folder.getMetadata();

  // Unknown type metadata field, you can test for type or try to get as any type
  JsonValue unknownValue = metadata.getValue("/someField");

  // String or Enum metadata fields
  String stringValue = metadata.getString("/author");

  // Float metadata fields can be interpreted as any numeric type
  float floatValue = metadata.getFloat("/price");

  // Date metadata fields
  Date dateValue = metadata.getDate("/deadline");
  ```

  ```py Python v4 theme={null}
  metadata = client.folder(folder_id='22222').metadata(scope='enterprise', template='myMetadata').get()
  print(f'Got metadata instance {metadata["$id"]}')
  ```

  ```csharp .NET v6 theme={null}
  Dictionary<string, object> metadata = await client.MetadataManager.
      .GetFolderMetadataAsync(folderId: "11111", "enterprise", "marketingCollateral");
  ```

  ```js Node v4 theme={null}
  client.folders.getMetadata('11111', client.metadata.scopes.ENTERPRISE, 'marketingCollateral')
   .then(metadata => {
    /* metadata -> {
     audience: 'internal',
     documentType: 'Q1 plans',
     competitiveDocument: 'no',
     status: 'active',
     author: 'Jones',
     currentState: 'proposal',
     '$type': 'marketingCollateral-d086c908-2498-4d3e-8a1f-01e82bfc2abe',
     '$parent': 'folder_11111',
     '$id': '2094c584-68e1-475c-a581-534a4609594e',
     '$version': 0,
     '$typeVersion': 0,
     '$template': 'marketingCollateral',
     '$scope': 'enterprise_12345' }
    */
   });
  ```
</CodeGroup>

<Info>
  To get the `scope` and `templateKey` for a template, either
  <Link href="/guides/metadata/templates/list">list all metadata templates</Link>, or
  <Link href="/guides/metadata/instances/list">list all instances on an folder</Link>.
</Info>

[e_on_folder]: /reference/get-folders-id-metadata-id-id

<RelatedLinks
  title="RELATED APIS"
  items={[
{ label: translate("Get metadata instance on file"), href: "/reference/get-files-id-metadata-id-id", badge: "GET" },
{ label: translate("Get metadata instance on folder"), href: "/reference/get-folders-id-metadata-id-id", badge: "GET" }
]}
/>

<RelatedLinks
  title="RELATED GUIDES"
  items={[
{ label: translate("List all metadata on an item"), href: "/guides/metadata/instances/list", badge: "GUIDE" },
{ label: translate("Apply metadata to an item"), href: "/guides/metadata/instances/create", badge: "GUIDE" },
{ label: translate("Metadata template scopes"), href: "/guides/metadata/scopes", badge: "GUIDE" },
{ label: translate("List all metadata templates"), href: "/guides/metadata/templates/list", badge: "GUIDE" }
]}
/>

<RelatedLinks
  title="RELATED RESOURCES"
  items={[
{ label: translate("Metadata"), href: "/guides/metadata/index", badge: "GUIDE" }
]}
/>