0

Get files under retention

by
Published Oct 17, 2025

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