Go to console

Method: projects.searchApps

A convenience method that lists all available Apps for the specified FirebaseProject.

Typically, interaction with an App should be done using the platform-specific service, but some tool use-cases require a summary of all known Apps (such as for App selector interfaces).

HTTP request

GET https://firebase.googleapis.com/v1beta1/{parent=projects/*}:searchApps

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

The parent Project for which to list Apps, in the format:

projects/projectId

Query parameters

Parameters
pageToken

string

Token returned from a previous call to projects.searchApps indicating where in the set of Apps to resume listing.

pageSize

number

The maximum number of Apps to return in the response.

The server may return fewer than this value at its discretion. If no value is specified (or too large a value is specified), then the server will impose its own limit.

This value cannot be negative.

Request body

The request body must be empty.

Response body

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

JSON representation
{
  "apps": [
    {
      object (FirebaseAppInfo)
    }
  ],
  "nextPageToken": string
}
Fields
apps[]

object (FirebaseAppInfo)

One page of results from a call to projects.searchApps.

nextPageToken

string

If the result list is too large to fit in a single response, then a token is returned.

This token can be used in a subsequent calls to projects.searchApps to find the next group of Apps.
If the string is empty, then this response is the last page of results.
Page tokens are short-lived and should not be persisted.

Authorization Scopes

Requires one of the following OAuth scopes:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/cloud-platform.read-only
  • https://www.googleapis.com/auth/firebase
  • https://www.googleapis.com/auth/firebase.readonly

For more information, see the Authentication Overview.

FirebaseAppInfo

A high-level summary of an App.

JSON representation
{
  "name": string,
  "displayName": string,
  "platform": enum (AppPlatform),
  "appId": string
}
Fields
name

string

The fully qualified resource name of the Firebase App, in the format:

projects/projectId/iosApps/appId

or

projects/projectId/androidApps/appId

displayName

string

The user-assigned display name of the Firebase App.

platform

enum (AppPlatform)

The platform of the Firebase App.

appId

string

Immutable. The globally unique, Firebase-assigned identifier of the App.

This identifier should be treated as an opaque token, as the data format is not specified.

AppPlatform

Platforms with which a Firebase App can be associated.

Enums
PLATFORM_UNSPECIFIED Unknown state. This is only used for distinguishing unset values.
IOS The Firebase App is associated with iOS.
ANDROID The Firebase App is associated with Android.
WEB The Firebase App is associated with web.

Try it!