Method: accounts.list
Stay organized with collections
Save and categorize content based on your preferences.
Note: For the accounts.list method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the accounts.listSubaccounts method, which is more suitable for advanced accounts use case.
HTTP request
GET https://merchantapi.googleapis.com/accounts/v1beta/accounts
The URL uses gRPC Transcoding syntax.
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 in the accounts.list request must match the call that provided the page token.
|
filter |
string
Optional. Returns only accounts that match the filter. For more details, see the filter syntax reference.
|
Request body
The request body must be empty.
Response body
Response message for the accounts.list 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 matching the ListAccountsRequest.
|
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.
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-06-21 UTC.
[null,null,["Last updated 2025-06-21 UTC."],[[["\u003cp\u003eLists all accessible accounts for the calling user, including linked accounts and those from multiple MCAs, based on optional filtering.\u003c/p\u003e\n"],["\u003cp\u003eSupports pagination with \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e parameters for retrieving large result sets.\u003c/p\u003e\n"],["\u003cp\u003eAllows filtering accounts using a dedicated filter syntax for refined searches.\u003c/p\u003e\n"],["\u003cp\u003eRequires \u003ccode\u003ehttps://www.googleapis.com/auth/content\u003c/code\u003e OAuth scope for authorization.\u003c/p\u003e\n"],["\u003cp\u003eProvides account details in the response, including a \u003ccode\u003enextPageToken\u003c/code\u003e for accessing further pages if available.\u003c/p\u003e\n"]]],["This document details how to retrieve a list of user-accessible accounts via an HTTP GET request to `https://merchantapi.googleapis.com/accounts/v1beta/accounts`. Optional query parameters include `pageSize` (default 250, max 500), `pageToken` for pagination, and `filter` to narrow results. The request body must be empty. The response includes a JSON array of `accounts` and an optional `nextPageToken` for subsequent pages. The operation requires the `https://www.googleapis.com/auth/content` authorization scope and is eventually consistent.\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- [Try it!](#try-it)\n\nNote: For the `accounts.list` method, quota and limits usage are charged for each user, and not for the Merchant Center ID or the advanced account ID. To list several sub-accounts, you should use the `accounts.listSubaccounts` method, which is more suitable for advanced accounts use case.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/accounts/v1beta/accounts`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `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. |\n| `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 in the `accounts.list` request must match the call that provided the page token. |\n| `filter` | `string` Optional. Returns only accounts that match the [filter](https://developers.google.com/merchant/api/guides/accounts/filter). For more details, see the [filter syntax reference](https://developers.google.com/merchant/api/guides/accounts/filter-syntax). |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the `accounts.list` method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"accounts\": [ { object (/merchant/api/reference/rest/accounts_v1beta/accounts#Account) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `accounts[]` | `object (`[Account](/merchant/api/reference/rest/accounts_v1beta/accounts#Account)`)` The accounts matching the `ListAccountsRequest`. |\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)."]]
