0

Get file versions under retention

by
Published Oct 17, 2025

Returns a list of file versions under retention for a retention policy assignment.

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 file versions under retention
7
 * Returns a list of file versions under retention for a retention policy
8
assignment.
9
 */
10
export async function main(
11
  auth: Box,
12
  retention_policy_assignment_id: string,
13
  marker: string | undefined,
14
  limit: string | undefined,
15
) {
16
  const url = new URL(
17
    `https://api.box.com/2.0/retention_policy_assignments/${retention_policy_assignment_id}/file_versions_under_retention`,
18
  );
19
  for (const [k, v] of [
20
    ["marker", marker],
21
    ["limit", limit],
22
  ]) {
23
    if (v !== undefined && v !== "" && k !== undefined) {
24
      url.searchParams.append(k, v);
25
    }
26
  }
27
  const response = await fetch(url, {
28
    method: "GET",
29
    headers: {
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: undefined,
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40