The Verifications API and Business Information API is now launched! Migration work is required. Please see our deprecation schedule for more information related to deprecated endpoints. You may also sign up for our mailing list to receive updates.

Method: accounts.list

Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights.

HTTP request

GET https://mybusinessaccountmanagement.googleapis.com/v1/accounts

The URL uses gRPC Transcoding syntax.

Query parameters

Parameters
parentAccount

string

Optional. The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return accounts.list for the authenticated user. accounts/{account_id}.

pageSize

integer

Optional. How many accounts to fetch per page. The minimum supported pageSize is 2. The default and maximum is 20.

pageToken

string

Optional. If specified, the next page of accounts is retrieved. The pageToken is returned when a call to accounts.list returns more results than can fit into the requested page size.

filter

string

Optional. A filter constraining the accounts to return. The response includes only entries that match the filter. If filter is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account.

For example, a request with the filter type=USER_GROUP will only return user groups.

The type field is the only supported filter.

Request body

The request body must be empty.

Response body

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

Response message for Accounts.ListAccounts.

JSON representation
{
  "accounts": [
    {
      object (Account)
    }
  ],
  "nextPageToken": string
}
Fields
accounts[]

object (Account)

A collection of accounts to which the user has access. The personal account of the user doing the query will always be the first item of the result, unless it is filtered out.

nextPageToken

string

If the number of accounts exceeds the requested page size, this field is populated with a token to fetch the next page of accounts on a subsequent call to accounts.list. If there are no more accounts, this field is not present in the response.

Authorization Scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/business.manage

For more information, see the OAuth 2.0 Overview.