Method: projects.locations.catalogs.branches.list

Lists all instances of Branch under the specified parent Catalog.

HTTP request

GET https://retail.googleapis.com/v2alpha/{parent=projects/*/locations/*/catalogs/*}/branches

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The parent catalog resource name.

Query parameters

Parameters
view

enum (BranchView)

The view to apply to the returned Branch. Defaults to [Branch.BranchView.BASIC] if unspecified. See documentation of fields of Branch to find what fields are excluded from BASIC view.

Request body

The request body must be empty.

Response body

Response for BranchService.ListBranches method.

If successful, the response body contains data with the following structure:

JSON representation
{
  "branches": [
    {
      object (Branch)
    }
  ]
}
Fields
branches[]

object (Branch)

The Branches.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the parent resource:

  • retail.branches.list

For more information, see the IAM documentation.