0

List file version retentions

by
Published Oct 17, 2025

Retrieves all file version retentions for the given enterprise. **Note**: File retention API is now **deprecated**. To get information about files and file versions under retention, see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.

Script box Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Box = {
3
  token: string;
4
};
5
/**
6
 * List file version retentions
7
 * Retrieves all file version retentions for the given enterprise.
8

9
**Note**:
10
File retention API is now **deprecated**. 
11
To get information about files and file versions under retention,
12
see [files under retention](e://get-retention-policy-assignments-id-files-under-retention) or [file versions under retention](e://get-retention-policy-assignments-id-file-versions-under-retention) endpoints.
13
 */
14
export async function main(
15
  auth: Box,
16
  file_id: string | undefined,
17
  file_version_id: string | undefined,
18
  policy_id: string | undefined,
19
  disposition_action: "permanently_delete" | "remove_retention" | undefined,
20
  disposition_before: string | undefined,
21
  disposition_after: string | undefined,
22
  limit: string | undefined,
23
  marker: string | undefined,
24
) {
25
  const url = new URL(`https://api.box.com/2.0/file_version_retentions`);
26
  for (const [k, v] of [
27
    ["file_id", file_id],
28
    ["file_version_id", file_version_id],
29
    ["policy_id", policy_id],
30
    ["disposition_action", disposition_action],
31
    ["disposition_before", disposition_before],
32
    ["disposition_after", disposition_after],
33
    ["limit", limit],
34
    ["marker", marker],
35
  ]) {
36
    if (v !== undefined && v !== "" && k !== undefined) {
37
      url.searchParams.append(k, v);
38
    }
39
  }
40
  const response = await fetch(url, {
41
    method: "GET",
42
    headers: {
43
      Authorization: "Bearer " + auth.token,
44
    },
45
    body: undefined,
46
  });
47
  if (!response.ok) {
48
    const text = await response.text();
49
    throw new Error(`${response.status} ${text}`);
50
  }
51
  return await response.json();
52
}
53