0

Get metadata instance on file

by
Published Oct 17, 2025

Retrieves the instance of a metadata template that has been applied to a file.

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 instance on file
7
 * Retrieves the instance of a metadata template that has been applied to a
8
file.
9
 */
10
export async function main(
11
  auth: Box,
12
  file_id: string,
13
  scope: "global" | "enterprise",
14
  template_key: string,
15
) {
16
  const url = new URL(
17
    `https://api.box.com/2.0/files/${file_id}/metadata/${scope}/${template_key}`,
18
  );
19

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