Method: accounts.users.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all users of a Merchant Center account.
HTTP request
GET https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/users
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent, which owns this collection of users. Format: accounts/{account}
|
Query parameters
| Parameters |
pageSize |
integer
Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100
|
pageToken |
string
Optional. A page token, received from a previous users.list call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to users.list must match the call that provided the page token.
|
Request body
The request body must be empty.
Response body
Response message for the users.list method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"users": [
{
object (User)
}
],
"nextPageToken": string
} |
| Fields |
users[] |
object (User)
The users from the specified account.
|
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-07-31 UTC.
[null,null,["Last updated 2025-07-31 UTC."],[],[],null,["# Method: accounts.users.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.ListUsersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all users of a Merchant Center account.\n\n### HTTP request\n\n`GET https://merchantapi.googleapis.com/accounts/v1/{parent=accounts/*}/users`\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 parent, which owns this collection of users. Format: `accounts/{account}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. The maximum number of users to return. The service may return fewer than this value. If unspecified, at most 50 users will be returned. The maximum value is 100; values above 100 will be coerced to 100 |\n| `pageToken` | `string` Optional. A page token, received from a previous `users.list` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `users.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 `users.list` method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"users\": [ { object (/merchant/api/reference/rest/accounts_v1/accounts.users#User) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|----------------------------------------------------------------------------------------------------------------------------------------|\n| `users[]` | `object (`[User](/merchant/api/reference/rest/accounts_v1/accounts.users#User)`)` The users from the specified account. |\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)."]]
