0

Get a site structure

by
Published Oct 17, 2025

Get the complete structure of a site that includes all its site-sections and site-spaces.

Script gitbook Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Gitbook = {
3
  token: string;
4
};
5
/**
6
 * Get a site structure
7
 * Get the complete structure of a site that includes all its site-sections and site-spaces.
8
 */
9
export async function main(
10
  auth: Gitbook,
11
  organizationId: string,
12
  siteId: string,
13
  shareKey: string | undefined,
14
) {
15
  const url = new URL(
16
    `https://api.gitbook.com/v1/orgs/${organizationId}/sites/${siteId}/structure`,
17
  );
18
  for (const [k, v] of [["shareKey", shareKey]]) {
19
    if (v !== undefined && v !== "" && k !== undefined) {
20
      url.searchParams.append(k, v);
21
    }
22
  }
23
  const response = await fetch(url, {
24
    method: "GET",
25
    headers: {
26
      Authorization: "Bearer " + auth.token,
27
    },
28
    body: undefined,
29
  });
30
  if (!response.ok) {
31
    const text = await response.text();
32
    throw new Error(`${response.status} ${text}`);
33
  }
34
  return await response.json();
35
}
36