Method: accounts.gbpAccounts.list
Stay organized with collections
Save and categorize content based on your preferences.
List the GBP accounts for a given merchant.
HTTP request
GET https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/gbpAccounts
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters |
parent |
string
Required. The name of the parent resource under which the GBP accounts are listed. Format: accounts/{account} .
|
Query parameters
Parameters |
pageSize |
integer
Optional. The maximum number of GbpAccount resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the pageSize . The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the pageSize will default to the maximum.
|
pageToken |
string
Optional. A page token, received from a previous gbpAccounts.list call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to gbpAccounts.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for the gbpAccounts.list method.
If successful, the response body contains data with the following structure:
JSON representation |
{
"gbpAccounts": [
{
object (GbpAccount )
}
],
"nextPageToken": string
} |
Fields |
gbpAccounts[] |
object (GbpAccount )
The GBP accounts from the specified merchant in the specified country.
|
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.
GbpAccount
Collection of information related to a Google Business Profile (GBP) account.
JSON representation |
{
"name": string,
"gbpAccountId": string,
"type": enum (Type ),
"gbpAccountName": string,
"listingCount": string
} |
Fields |
name |
string
Identifier. The resource name of the GBP account. Format: accounts/{account}/gbpAccount/{gbp_account}
|
gbpAccountId |
string
The id of the GBP account.
|
type |
enum (Type )
The type of the Business Profile.
|
gbpAccountName |
string
The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account.
|
listingCount |
string (int64 format)
Number of listings under this account.
|
Type
The type of the GBP account.
Enums |
TYPE_UNSPECIFIED |
Default value. This value is unused. |
USER |
The GBP account is a user account. |
BUSINESS_ACCOUNT |
The GBP account is a business account. |
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 2025-07-31 UTC.
[null,null,["Last updated 2025-07-31 UTC."],[],[],null,["# Method: accounts.gbpAccounts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListGbpAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [GbpAccount](#GbpAccount)\n - [JSON representation](#GbpAccount.SCHEMA_REPRESENTATION)\n- [Type](#Type)\n- [Try it!](#try-it)\n\nList the GBP accounts for a given merchant.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/gbpAccounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|---------------------------------------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. The name of the parent resource under which the GBP accounts are listed. Format: `accounts/{account}`. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of `GbpAccount` resources to return. The service returns fewer than this value if the number of gbp accounts is less that than the `pageSize`. The default value is 50. The maximum value is 1000; If a value higher than the maximum is specified, then the `pageSize` will default to the maximum. |\n| `pageToken` | `string` Optional. A page token, received from a previous `gbpAccounts.list` call. Provide the page token to retrieve the subsequent page. When paginating, all other parameters provided to `gbpAccounts.list` must match the call that provided the page token. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the gbpAccounts.list method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"gbpAccounts\": [ { object (/merchant/api/reference/rest/accounts_v1/accounts.gbpAccounts/list#GbpAccount) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `gbpAccounts[]` | `object (`[GbpAccount](/merchant/api/reference/rest/accounts_v1/accounts.gbpAccounts/list#GbpAccount)`)` The GBP accounts from the specified merchant in the specified country. |\n| `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. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/content`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2).\n\nGbpAccount\n----------\n\nCollection of information related to a Google Business Profile (GBP) account.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"gbpAccountId\": string, \"type\": enum (/merchant/api/reference/rest/accounts_v1/accounts.gbpAccounts/list#Type), \"gbpAccountName\": string, \"listingCount\": string } ``` |\n\n| Fields ||\n|------------------|-----------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Identifier. The resource name of the GBP account. Format: `accounts/{account}/gbpAccount/{gbp_account}` |\n| `gbpAccountId` | `string` The id of the GBP account. |\n| `type` | `enum (`[Type](/merchant/api/reference/rest/accounts_v1/accounts.gbpAccounts/list#Type)`)` The type of the Business Profile. |\n| `gbpAccountName` | `string` The name of the Business Profile. For personal accounts: Email id of the owner. For Business accounts: Name of the Business Account. |\n| `listingCount` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Number of listings under this account. |\n\nType\n----\n\nThe type of the GBP account.\n\n| Enums ||\n|--------------------|----------------------------------------|\n| `TYPE_UNSPECIFIED` | Default value. This value is unused. |\n| `USER` | The GBP account is a user account. |\n| `BUSINESS_ACCOUNT` | The GBP account is a business account. |"]]