0

List all collections users permissions

by
Published Oct 17, 2025
Script gitbook Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Gitbook = {
3
  token: string;
4
};
5
/**
6
 * List all collections users permissions
7
 *
8
 */
9
export async function main(
10
  auth: Gitbook,
11
  collectionId: string,
12
  page: string | undefined,
13
  limit: string | undefined,
14
  role: "admin" | "create" | "edit" | "review" | "comment" | "read" | undefined,
15
) {
16
  const url = new URL(
17
    `https://api.gitbook.com/v1/collections/${collectionId}/permissions/aggregate`,
18
  );
19
  for (const [k, v] of [
20
    ["page", page],
21
    ["limit", limit],
22
    ["role", role],
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