0

List sites

by
Published Oct 17, 2025

**Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.

Script netlify Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
type Netlify = {
3
  token: string;
4
};
5
/**
6
 * List sites
7
 * **Note:** Environment variable keys and values have moved from `build_settings.env` and `repo.env` to a new endpoint. Please use [getEnvVars](#tag/environmentVariables/operation/getEnvVars) to retrieve site environment variables.
8
 */
9
export async function main(
10
  auth: Netlify,
11
  name: string | undefined,
12
  filter: "all" | "owner" | "guest" | undefined,
13
  page: string | undefined,
14
  per_page: string | undefined,
15
) {
16
  const url = new URL(`https://api.netlify.com/api/v1/sites`);
17
  for (const [k, v] of [
18
    ["name", name],
19
    ["filter", filter],
20
    ["page", page],
21
    ["per_page", per_page],
22
  ]) {
23
    if (v !== undefined && v !== "" && k !== undefined) {
24
      url.searchParams.append(k, v);
25
    }
26
  }
27
  const response = await fetch(url, {
28
    method: "GET",
29
    headers: {
30
      Authorization: "Bearer " + auth.token,
31
    },
32
    body: undefined,
33
  });
34
  if (!response.ok) {
35
    const text = await response.text();
36
    throw new Error(`${response.status} ${text}`);
37
  }
38
  return await response.json();
39
}
40