Get branches

get

https://api.readme.com/v2/branches

Get a collection of branches in your ReadMe project.

📘
This route is only available to projects that are using ReadMe Refactored.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

sort_by

string

enum

Defaults to semver

The sort that should be used for the returned collection. A paginated branch list (page or per_page) sorted by review_status is returned most recently updated first instead.

Allowed:

prefix

string

stable|\bmain(?:-[a-z]{2})?(?![\w.-])|([0-9]+)(?:\.([0-9]+))?(?:\.([0-9]+))?(-.*)?

An optional prefix in the format of v2.0 used to list all branches with this prefix.

page

number

≥ 1

Used to specify further pages (starts at 1). Only applies alongside prefix; omit both page and per_page to get every branch.

per_page

number

1 to 100

Number of branches to include per page (up to 100, defaults to 10 when page is set).

string

length ≤ 200

Optional case-insensitive search against branch names, or a review status (draft, ready, in review, approved). Only applies alongside prefix.

Response

200OK