0

Get all categories

by
Published Oct 17, 2025

Get all categories within a section of your ReadMe project. The sorting of this data is dependent upon the order of the categories in your sidebar. >📘 > 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 all categories
4
 * Get all categories within a section of your ReadMe project.
5

6
The sorting of this data is dependent upon the order of the categories in your sidebar.
7

8
>📘
9
> This route is only available to projects that are using [ReadMe Refactored](https://docs.readme.com/main/docs/welcome-to-readme-refactored).
10
 */
11
export async function main(auth: RT.Readme, section: 'guides' | 'reference', branch: string) {
12
	const url = new URL(`https://api.readme.com/v2/branches/${branch}/categories/${section}`)
13

14
	const response = await fetch(url, {
15
		method: 'GET',
16
		headers: {
17
			Authorization: 'Bearer ' + auth.apiKey
18
		},
19
		body: undefined
20
	})
21
	if (!response.ok) {
22
		const text = await response.text()
23
		throw new Error(`${response.status} ${text}`)
24
	}
25
	return await response.json()
26
}
27