0

List file collaborations

by
Published Oct 17, 2025

Retrieves a list of pending and active collaborations for a file. This returns all the users that have access to the file or have been invited to the 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
 * List file collaborations
7
 * Retrieves a list of pending and active collaborations for a
8
file. This returns all the users that have access to the file
9
or have been invited to the file.
10
 */
11
export async function main(
12
  auth: Box,
13
  file_id: string,
14
  fields: string | undefined,
15
  limit: string | undefined,
16
  marker: string | undefined,
17
) {
18
  const url = new URL(
19
    `https://api.box.com/2.0/files/${file_id}/collaborations`,
20
  );
21
  for (const [k, v] of [
22
    ["fields", fields],
23
    ["limit", limit],
24
    ["marker", marker],
25
  ]) {
26
    if (v !== undefined && v !== "" && k !== undefined) {
27
      url.searchParams.append(k, v);
28
    }
29
  }
30
  const response = await fetch(url, {
31
    method: "GET",
32
    headers: {
33
      Authorization: "Bearer " + auth.token,
34
    },
35
    body: undefined,
36
  });
37
  if (!response.ok) {
38
    const text = await response.text();
39
    throw new Error(`${response.status} ${text}`);
40
  }
41
  return await response.json();
42
}
43