0

Get a reference page

by
Published Oct 17, 2025

Get a page from the API Reference section of your ReadMe project. >📘 > This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).

Script readme Verified

The script

Submitted by hugo697 Bun
Verified 235 days ago
1
//native
2
/**
3
 * Get a reference page
4
 * Get a page from the API Reference section of your ReadMe project.
5

6
>📘
7
> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).
8
 */
9
export async function main(
10
	auth: RT.Readme,
11
	branch: string,
12
	slug: string,
13
	dereference?: 'true' | 'false' | undefined,
14
	reduce?: 'true' | 'false' | undefined
15
) {
16
	const url = new URL(`https://api.readme.com/v2/branches/${branch}/reference/${slug}`)
17
	for (const [k, v] of [
18
		['dereference', dereference],
19
		['reduce', reduce]
20
	]) {
21
		if (v !== undefined && v !== '') {
22
			url.searchParams.append(k, v)
23
		}
24
	}
25
	const response = await fetch(url, {
26
		method: 'GET',
27
		headers: {
28
			Authorization: 'Bearer ' + auth.apiKey
29
		},
30
		body: undefined
31
	})
32
	if (!response.ok) {
33
		const text = await response.text()
34
		throw new Error(`${response.status} ${text}`)
35
	}
36
	return await response.json()
37
}
38