Method: accounts.listSubaccounts

List all sub-accounts for a given multi client account. This is a convenience wrapper for the more powerful accounts.list method. This method will produce the same results as calling ListsAccounts with the following filter: relationship(providerId={parent} AND service(type="ACCOUNT_AGGREGATION"))

HTTP request

GET https://merchantapi.googleapis.com/accounts/v1beta/{provider=accounts/*}:listSubaccounts

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
provider

string

Required. The parent account. Format: accounts/{account}

Query parameters

Parameters
pageSize

integer

Optional. The maximum number of accounts to return. The service may return fewer than this value. If unspecified, at most 250 accounts are returned. The maximum value is 500; values above 500 are coerced to 500.
pageToken

string

Optional. A page token, received from a previous accounts.list call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to accounts.list must match the call that provided the page token.

Request body

The request body must be empty.

Response body

Response message for the accounts.listSubaccounts method.

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

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

object (Account)

The accounts for which the given parent account is an aggregator.
nextPageToken

string

A token, which can be sent as pageToken to retrieve the next page. If this field is omitted, there are no subsequent pages.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/content

For more information, see the OAuth 2.0 Overview.