0

List members of group

by
Published Oct 17, 2025

Retrieves all the members for 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
 * List members of group
7
 * Retrieves all the members for 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
  limit: string | undefined,
15
  offset: string | undefined,
16
) {
17
  const url = new URL(`https://api.box.com/2.0/groups/${group_id}/memberships`);
18
  for (const [k, v] of [
19
    ["limit", limit],
20
    ["offset", offset],
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