Lists Organization resources that are visible to the user and satisfy the specified filter. This method returns Organizations in an unspecified order. New Organizations do not necessarily appear at the end of the list.
HTTP request
GET https://cloudresourcemanager.googleapis.com/v1beta1/organizations
The URL uses gRPC Transcoding syntax.
Query parameters
pageSize
integer
The maximum number of Organizations to return in the response. This field is optional.
pageToken
string
A pagination token returned from a previous call to organizations.list
that indicates from where listing should continue. This field is optional.
filter
string
An optional query string used to filter the Organizations to return in the response. Filter rules are case-insensitive.
Organizations may be filtered by owner.directoryCustomerId
or by domain
, where the domain is a verified G Suite domain, for example:
- Filter
owner.directorycustomerid:123456789returns Organization resources withowner.directory_customer_idequal to123456789. - Filter
domain:google.comreturns Organization resources corresponding to the domaingoogle.com.
This field is optional.
Request body
The request body must be empty.
Response body
The response returned from the organizations.list
method.
If successful, the response body contains data with the following structure:
| JSON representation |
|---|
{
"organizations"
:
[
{
object (
|
| Fields | |
|---|---|
organizations[]
|
The list of Organizations that matched the list query, possibly paginated. |
nextPageToken
|
A pagination token to be used to retrieve the next page of results. If the result is too large to fit within the page size specified in the request, this field will be set with a token that can be used to fetch the next page of results. If this field is empty, it indicates that this response contains the last page of results. |
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/cloudplatformorganizations -
https://www.googleapis.com/auth/cloudplatformorganizations.readonly
For more information, see the Authentication Overview .
