Skip to main content
GET
List branches

Authorizations

Authorization
string
header
required

Use a JWT bearer token or a Veryfront API key in the Authorization header.

Path Parameters

project_reference
string
required
Example:

"my-project"

Query Parameters

limit
integer

Page size 1-100. Omit limit and cursor for the complete collection; cursor alone defaults to 20.

Required range: 1 <= x <= 100
Example:

20

cursor
string

Opaque continuation bound to collection, project, branch, principal, filters and page size. Paged records use ID ascending order.

Required string length: 1 - 4096

Search filter for branch name (case-insensitive partial match)

Example:

"feature"

status
enum<string>
default:all

Filter by branch status

Available options:
active,
merged,
closed,
all
Example:

"active"

Response

List of branches.

data
object[]
required
page_info
object