0

Get branches

by
Published Oct 17, 2025

Get a collection of branches in 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 branches
4
 * Get a collection of branches in 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
	sort_by?: 'created' | 'review_status' | 'semver' | 'updated' | undefined,
12
	prefix?: string | undefined
13
) {
14
	const url = new URL(`https://api.readme.com/v2/branches`)
15
	for (const [k, v] of [
16
		['sort_by', sort_by],
17
		['prefix', prefix]
18
	]) {
19
		if (v !== undefined && v !== '') {
20
			url.searchParams.append(k, v)
21
		}
22
	}
23
	const response = await fetch(url, {
24
		method: 'GET',
25
		headers: {
26
			Authorization: 'Bearer ' + auth.apiKey
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