0

List groups for enterprise

by
Published Oct 17, 2025

Retrieves all of the groups for a given enterprise. The user must have admin permissions to inspect enterprise's groups.

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 groups for enterprise
7
 * Retrieves all of the groups for a given enterprise. The user
8
must have admin permissions to inspect enterprise's groups.
9
 */
10
export async function main(
11
  auth: Box,
12
  filter_term: string | undefined,
13
  fields: string | undefined,
14
  limit: string | undefined,
15
  offset: string | undefined,
16
) {
17
  const url = new URL(`https://api.box.com/2.0/groups`);
18
  for (const [k, v] of [
19
    ["filter_term", filter_term],
20
    ["fields", fields],
21
    ["limit", limit],
22
    ["offset", offset],
23
  ]) {
24
    if (v !== undefined && v !== "" && k !== undefined) {
25
      url.searchParams.append(k, v);
26
    }
27
  }
28
  const response = await fetch(url, {
29
    method: "GET",
30
    headers: {
31
      Authorization: "Bearer " + auth.token,
32
    },
33
    body: undefined,
34
  });
35
  if (!response.ok) {
36
    const text = await response.text();
37
    throw new Error(`${response.status} ${text}`);
38
  }
39
  return await response.json();
40
}
41