0

Get group

by
Published Oct 17, 2025

Retrieves information about a group. Only members of this group or users with admin-level permissions will be able to use this API.

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 group
7
 * Retrieves information about a group. Only members of this
8
group or users with admin-level permissions will be able to
9
use this API.
10
 */
11
export async function main(
12
  auth: Box,
13
  group_id: string,
14
  fields: string | undefined,
15
) {
16
  const url = new URL(`https://api.box.com/2.0/groups/${group_id}`);
17
  for (const [k, v] of [["fields", fields]]) {
18
    if (v !== undefined && v !== "" && k !== undefined) {
19
      url.searchParams.append(k, v);
20
    }
21
  }
22
  const response = await fetch(url, {
23
    method: "GET",
24
    headers: {
25
      Authorization: "Bearer " + auth.token,
26
    },
27
    body: undefined,
28
  });
29
  if (!response.ok) {
30
    const text = await response.text();
31
    throw new Error(`${response.status} ${text}`);
32
  }
33
  return await response.json();
34
}
35