Method: folders.list

Lists the folders that are direct descendants of supplied parent resource. list() provides a strongly consistent view of the folders underneath the specified parent resource. list() returns folders sorted based upon the (ascending) lexical ordering of their displayName. The caller must have resourcemanager.folders.list permission on the identified parent.

HTTP request

GET https://cloudresourcemanager.googleapis.com/v3/folders

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
parent

string

Required. The name of the parent resource whose folders are being listed. Only children of this parent resource are listed; descendants are not listed.

If the parent is a folder, use the value folders/{folder_id}. If the parent is an organization, use the value organizations/{org_id}.

Access to this method is controlled by checking the resourcemanager.folders.list permission on the parent.
pageSize

integer

Optional. The maximum number of folders to return in the response. The server can return fewer folders than requested. If unspecified, server picks an appropriate default.
pageToken

string

Optional. A pagination token returned from a previous call to folders.list that indicates where this listing should continue from.
showDeleted

boolean

Optional. Controls whether folders in the DELETE_REQUESTED state should be returned. Defaults to false.

Request body

The request body must be empty.

Response body

The folders.list response message.

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

JSON representation 
{
  "folders": [
    {
      object (Folder)
    }
  ],
  "nextPageToken": string
}
Fields
folders[]

object (Folder)

A possibly paginated list of folders that are direct descendants of the specified parent resource.
nextPageToken

string

A pagination token returned from a previous call to folders.list that indicates from where listing should continue.

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/cloudplatformfolders
  • https://www.googleapis.com/auth/cloudplatformfolders.readonly

For more information, see the Authentication Overview.