dev.knotless.listBranches

A repository's branches, the default first and the rest by name, a page at a time: follow `cursor` until it is absent. No authentication needed; asked as an account, with a service token or the pages' session cookie, a private repository it is a member of is read too, and the answer is that account's alone.

Details · query
Kindquery
Authorityknotless.dev
Indexed

Query

query · GET

Parameters

query string

commits

boolean

Each branch's tip commit and its checks too, as a page of branches shows them, rather than its name alone, as a menu of them does.

  • default: false

cursor

string

How many branches the pages before held.

  • maxLength: 32

limit

integer
  • minimum: 1
  • maximum: 1000
  • default: 100

repo

requiredstring · at-uri

The repository's dev.knotless.repo record. Its authority may be a handle; a name the repository had before, or an owner it moved from with its agreement, finds it under the name it has now.

Output

application/json

branches

requiredarray
itemsref
Reference

cursor

string

Absent on the last page.

Errors

NotFound

No such repository, revision, path or record.

#branchView

object

One branch.

Properties

checks

array

The newest run of each workflow at its tip, by the runners the repository names, when `commits` was asked.

itemsref

Its tip, when `commits` was asked.

name

requiredstring

Its short name, without `refs/heads/`.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.