Method: organizations.appgroups.list

Lists all AppGroups in an organization. A maximum of 1000 AppGroups are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.

HTTP request

GET https://apigee.googleapis.com/v1/{parent=organizations/*}/appgroups

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Name of the Apigee organization. Use the following structure in your request: organizations/{org}.

Authorization requires the following IAM permission on the specified resource parent:

  • apigee.appgroups.list

Query parameters

Parameters
filter

string

The filter expression to be used to get the list of AppGroups, where filtering can be done on status, channelId or channelUri of the app group. Examples: filter=status=active", filter=channelId=, filter=channelUri=
pageSize

integer

Count of AppGroups a single page can have in the response. If unspecified, at most 1000 AppGroups will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken

string

The starting index record for listing the AppGroups.

Request body

The request body must be empty.

Response body

ListAppGroupsResponse contains the 0 or more AppGroups, along with the optional page token and the total count of apps.

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

JSON representation 
{
  "appGroups": [
    {
      object (AppGroup)
    }
  ],
  "nextPageToken": string,
  "totalSize": integer
}
Fields
appGroups[]

object (AppGroup)

List of AppGroups.
nextPageToken

string

Token that can be sent as nextPageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.
totalSize

integer

Total count of AppGroups.

Authorization scopes

Requires the following OAuth scope:

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