List branches

branchCollection(input: BranchCollectionInput!): BranchCollection!

Requires project.read.

Arguments

ArgumentTypeRequired
inputBranchCollectionInput!Yes

Input fields

input

BranchCollectionInput

FieldTypeRequiredDescription
projectReferenceString!YesProject UUID, slug, or domain. Requires project.read.
limitIntNoPage size 1-100; defaults to 20.
cursorStringNoPrevious endCursor or previousCursor from this collection, principal, filters and page size.
searchStringNoCase-insensitive partial branch-name match.
statusBranchCollectionStatusNoBranch status; omit for all persisted branches, including the root branch.

Response

Returns BranchCollection!. Open the type for its fields and nested types.

FieldTypeDescription
edges[BranchCollectionEdge!]!Persisted records in ID ascending order.
pageInfoPageInfo!
previousCursorStringOpaque continuation to the previous page, or null on the first page. Pass as cursor with the same filters and page size.

Types marked with ! cannot be null. Lists use [Type] notation. The type index lists all published input and response types.

Example

graphql
query BranchCollection($input: BranchCollectionInput!) {
  branchCollection(input: $input) {
    previousCursor
    edges {
      cursor
      node {
        id
        projectId
        name
        status
        createdAt
      }
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}
json
{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}