List branches - Veryfront

branchCollection(input: BranchCollectionInput!): BranchCollection!

Requires project.read.

Arguments

Argument	Type	Required
`input`	`BranchCollectionInput!`	Yes

Input fields

input

BranchCollectionInput

Field	Type	Required	Description
`projectReference`	`String!`	Yes	Project UUID, slug, or domain. Requires project.read.
`limit`	`Int`	No	Page size 1-100; defaults to 20.
`cursor`	`String`	No	Previous endCursor or previousCursor from this collection, principal, filters and page size.
`search`	`String`	No	Case-insensitive partial branch-name match.
`status`	`BranchCollectionStatus`	No	Branch status; omit for all persisted branches, including the root branch.

Response

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

Field	Type	Description
`edges`	`[BranchCollectionEdge!]!`	Persisted records in ID ascending order.
`pageInfo`	`PageInfo!`
`previousCursor`	`String`	Opaque 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

query BranchCollection($input: BranchCollectionInput!) {
  branchCollection(input: $input) {
    previousCursor
    edges {
      cursor
      node {
        id
        projectId
        name
        status
        createdAt
      }
    }
    pageInfo {
      hasNextPage
      endCursor
      hasPreviousPage
      startCursor
    }
  }
}

{
  "input": {
    "projectReference": "00000000-0000-4000-8000-000000000001"
  }
}