Method: projects.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists each FirebaseProject accessible to the caller.
The elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a pageToken.
This method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects.
Use projects.get for consistent reads as well as for additional Project details.
HTTP request
GET https://firebase.googleapis.com/v1beta1/projects
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageToken |
string
Token returned from a previous call to projects.list indicating where in the set of Projects to resume listing.
|
pageSize |
integer
The maximum number of Projects to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. This value cannot be negative.
|
showDeleted |
boolean
Optional. Controls whether Projects in the DELETED state should be returned in the response. If not specified, only ACTIVE Projects will be returned.
|
Request body
The request body must be empty.
Response body
If successful, the response body contains data with the following structure:
| JSON representation |
{
"results": [
{
object (FirebaseProject)
}
],
"nextPageToken": string
} |
| Fields |
results[] |
object (FirebaseProject)
One page of the list of Projects that are accessible to the caller.
|
nextPageToken |
string
If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to projects.list to find the next group of Projects. 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.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-24 UTC.
[null,null,["Last updated 2024-10-24 UTC."],[],[],null,["# Method: projects.list\n\nLists each [FirebaseProject](/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject) accessible to the caller.\n\nThe elements are returned in no particular order, but they will be a consistent view of the Projects when additional requests are made with a `pageToken`.\n\nThis method is eventually consistent with Project mutations, which means newly provisioned Projects and recent modifications to existing Projects might not be reflected in the set of Projects. The list will include only ACTIVE Projects.\n\nUse [projects.get](/docs/reference/firebase-management/rest/v1beta1/projects/get#google.firebase.service.v1beta1.FirebaseProjectService.GetFirebaseProject) for consistent reads as well as for additional Project details.\n\n### HTTP request\n\n`GET https://firebase.googleapis.com/v1beta1/projects`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `page``Token` | `string` Token returned from a previous call to `projects.list` indicating where in the set of Projects to resume listing. |\n| `page``Size` | `integer` The maximum number of Projects to return in the response. The server may return fewer than this at its discretion. If no value is specified (or too large a value is specified), the server will impose its own limit. This value cannot be negative. |\n| `show``Deleted` | `boolean` Optional. Controls whether Projects in the [DELETED](/docs/reference/firebase-management/rest/v1beta1/projects#State.ENUM_VALUES.DELETED) state should be returned in the response. If not specified, only `ACTIVE` Projects will be returned. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|--------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"results\": [ { object (/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|---------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `results[]` | `object (`[FirebaseProject](/docs/reference/firebase-management/rest/v1beta1/projects#FirebaseProject)`)` One page of the list of Projects that are accessible to the caller. |\n| `next``Page``Token` | `string` If the result list is too large to fit in a single response, then a token is returned. If the string is empty, then this response is the last page of results. This token can be used in a subsequent calls to `projects.list` to find the next group of Projects. Page tokens are short-lived and should not be persisted. |\n\n### Authorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/cloud-platform`\n- `\n https://www.googleapis.com/auth/cloud-platform.read-only`\n- `\n https://www.googleapis.com/auth/firebase`\n- `\n https://www.googleapis.com/auth/firebase.readonly`\n\nFor more information, see the [Authentication Overview](https://cloud.google.com/docs/authentication/)."]]
