Google Business Performance API has a
NEW API method that allows fetching multiple `DailyMetrics` in a single API request. Review the
deprecation schedule and instructions to migrate over from v4 reportInsights API method to Google Business Profile Performance API.
Method: accounts.list
Stay organized with collections
Save and categorize content based on your preferences.
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://mybusiness.googleapis.com/v4/accounts
The URL uses gRPC Transcoding syntax.
Query parameters
| Parameters |
pageSize |
integer
How many accounts to fetch per page. Default is 20, minimum is 2, and maximum page size is 20.
|
pageToken |
string
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.
|
name |
string
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.
|
filter |
string
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.
|
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 one of the following OAuth scopes:
https://www.googleapis.com/auth/plus.business.managehttps://www.googleapis.com/auth/business.manage
For more information, see the OAuth 2.0 Overview.
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 2024-10-16 UTC.
[null,null,["Last updated 2024-10-16 UTC."],[[["\u003cp\u003eThis API endpoint, now deprecated, was used to retrieve a list of Google My Business accounts for the authenticated user, including owned and managed accounts.\u003c/p\u003e\n"],["\u003cp\u003eThe response includes account details and a pagination token for retrieving additional results.\u003c/p\u003e\n"],["\u003cp\u003eFiltering options were available to narrow down the returned accounts based on criteria like account type.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization required either \u003ccode\u003ehttps://www.googleapis.com/auth/plus.business.manage\u003c/code\u003e or \u003ccode\u003ehttps://www.googleapis.com/auth/business.manage\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUsers should now utilize the Account Management API for similar functionality.\u003c/p\u003e\n"]]],["This document outlines how to retrieve a list of accounts for an authenticated user via a `GET` request to `https://mybusiness.googleapis.com/v4/accounts`. The request can utilize query parameters like `pageSize`, `pageToken`, `name`, and `filter` to control the results. The request body must be empty. A successful response includes an array of `accounts` and optionally a `nextPageToken` for pagination. Authorization requires specific OAuth scopes.\n"],null,["# Method: accounts.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAccountsResponse.SCHEMA_REPRESENTATION)\n- [Authorization Scopes](#body.aspect)\n\n| Deprecated. Please use the [Account Management API](https://developers.google.com/my-business/reference/accountmanagement/rest/v1/accounts/list) instead.\nLists 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.\n\n### HTTP request\n\n`GET https://mybusiness.googleapis.com/v4/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` How many accounts to fetch per page. Default is 20, minimum is 2, and maximum page size is 20. |\n| `pageToken` | `string` 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. |\n| `name` | `string` 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. |\n| `filter` | `string` 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. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\nResponse message for Accounts.ListAccounts.\n\n| JSON representation ||\n|-------------------------------------------------------------------------------------------------------------------|---|\n| ``` { \"accounts\": [ { object (/my-business/reference/rest/v4/accounts#Account) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[Account](/my-business/reference/rest/v4/accounts#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. |\n| `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. |\n\n### Authorization Scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/plus.business.manage`\n- `https://www.googleapis.com/auth/business.manage`\n\nFor more information, see the [OAuth 2.0 Overview](https://developers.google.com/identity/protocols/OAuth2)."]]