Method: organizations.apps.list

Lists IDs of apps within an organization that have the specified app status (approved or revoked) or are of the specified app type (developer or company).

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. Resource path of the parent in the following format: organizations/{org}

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

  • apigee.apps.list

Query parameters

Parameters
status

string

Optional. Filter by the status of the app. Valid values are approved or revoked. Defaults to approved.
apptype

string

Optional. 'apptype' is no longer available. Use a 'filter' instead.
includeCred

boolean

Optional. Flag that specifies whether to include credentials in the response.
startKey

string

Returns the list of apps starting from the specified app ID.
rows

string (int64 format)

Optional. Maximum number of app IDs to return. Defaults to 10000.
expand

boolean

Optional. Flag that specifies whether to return an expanded list of apps for the organization. Defaults to false.
ids

string

Optional. Comma-separated list of app IDs on which to filter.
keyStatus

string

Optional. Key status of the app. Valid values include approved or revoked. Defaults to approved.
apiProduct

string

API product.
pageSize

integer

Optional. Count of apps a single page can have in the response. If unspecified, at most 100 apps will be returned. The maximum value is 100; values above 100 will be coerced to 100. "pageSize" is supported from ver 1.10.0 and above.
pageToken

string

Optional. The starting index record for listing the developers. "pageToken" is supported from ver 1.10.0 and above.
filter

string

Optional. The filter expression to be used to get the list of apps, where filtering can be done on developerEmail, apiProduct, consumerKey, status, appId, appName, appType and appGroup. Examples: "developerEmail=foo@bar.com", "appType=AppGroup", or "appType=Developer" "filter" is supported from ver 1.10.0 and above.

Request body

The request body must be empty.

Response body

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

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

object (App)
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 Apps.

Authorization scopes

Requires the following OAuth scope:

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