BEbencherdev
projects
branches

List branches for a project

Changed on

List all branches for a project. If the project is public, then the user does not need to be authenticated. If the project is private, then the user must be authenticated and have view permissions for the project, or provide a valid project key for the project. By default, the branches are sorted in alphabetical order by name. The HTTP response header X-Total-Count contains the total number of branches.

get/v0/projects/{project}/branches

Request

  • The document declares no server URL.
  • Auth
    none declared

Path parameters

projectstring required

The slug or UUID for a project.

Query parameters

direction'asc' | 'desc'

The direction to sort by. If not specified, the default sort direction is used.

pageinteger nullable

The page number to return. If not specified, the first page is returned.

per_pageinteger nullable

The number of items to return per page. If not specified, the default number of items per page (8) is used.

sort'name'

Sort by branch name.

The field to sort by. If not specified, the default sort field is used.

archivedboolean nullable

If set to true, only returns archived branches, if set to true. If not set or set to false, only returns non-archived branches.

namestring

Filter by branch name, exact match.

searchstring

Search by branch name, slug, or UUID.

Response

successful operation

archivedstring date-time
createdstring date-time required
modifiedstring date-time required
namestring required
projectstring uuid required
slugstring required
uuidstring uuid required

Changes