Skip to content

List repository branches

GET
/v1/repos/{username}/{repo_name}/branches
username
required
Username
string
repo_name
required
Repo Name
string

Branch list. An empty repository returns 200 with branches: [] and default_branch: master.

BranchListResponse
object
branches
required
Branches
Array<object>
Branch
object
name
required
Name
string
commit
required
Commit
object
id
required
Id
string format: uuid
hexsha
required
Hexsha
string
message
required
Message
string
author
required
Author
object
name
required
Name
string
email
required
Email
string format: email
committer
required
Author
object
name
required
Name
string
email
required
Email
string format: email
default_branch
required
Default Branch
string
Example
{
"branches": [],
"default_branch": "master"
}

The repository was not found

GenericError
object
detail
Detail
Example
{
"detail": "Repo not found"
}

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string