0

Get metadata template by name

by
Published Oct 17, 2025

Retrieves a metadata template by its `scope` and `templateKey` values. To find the `scope` and `templateKey` for a template, list all templates for an enterprise or globally, or list all templates applied to a file or folder.

Script box Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Box = {
3
  token: string;
4
};
5
/**
6
 * Get metadata template by name
7
 * Retrieves a metadata template by its `scope` and `templateKey` values.
8

9
To find the `scope` and `templateKey` for a template, list all templates for
10
an enterprise or globally, or list all templates applied to a file or folder.
11
 */
12
export async function main(
13
  auth: Box,
14
  scope: "global" | "enterprise",
15
  template_key: string,
16
) {
17
  const url = new URL(
18
    `https://api.box.com/2.0/metadata_templates/${scope}/${template_key}/schema`,
19
  );
20

21
  const response = await fetch(url, {
22
    method: "GET",
23
    headers: {
24
      Authorization: "Bearer " + auth.token,
25
    },
26
    body: undefined,
27
  });
28
  if (!response.ok) {
29
    const text = await response.text();
30
    throw new Error(`${response.status} ${text}`);
31
  }
32
  return await response.json();
33
}
34