Method: buyers.clients.users.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all client users for a specified client.
HTTP request
GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*/clients/*}/users
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the client. Format: buyers/{buyerAccountId}/clients/{clientAccountId}
|
Query parameters
| Parameters |
pageSize |
integer
Requested page size. If left blank, a default page size of 500 will be applied.
|
pageToken |
string
A token identifying a page of results the server should return. Typically, this is the value of ListClientUsersResponse.nextPageToken returned from the previous call to the [list][users.list] method.
|
Request body
The request body must be empty.
Response body
Response message for the [list][users.list] method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"clientUsers": [
{
object (ClientUser)
}
],
"nextPageToken": string
} |
| Fields |
clientUsers[] |
object (ClientUser)
The returned list of client users.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the ListClientUsersRequest.pageToken field in the subsequent call to the [list][users.list] method to retrieve the next page of results.
|
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/authorized-buyers-marketplace
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-12 UTC.
[null,null,["Last updated 2025-06-12 UTC."],[[["\u003cp\u003eLists all client users for a specified client using an HTTP GET request.\u003c/p\u003e\n"],["\u003cp\u003eRequires the \u003ccode\u003eparent\u003c/code\u003e path parameter to specify the client and accepts optional \u003ccode\u003epageSize\u003c/code\u003e and \u003ccode\u003epageToken\u003c/code\u003e query parameters for pagination.\u003c/p\u003e\n"],["\u003cp\u003eThe response body includes an array of \u003ccode\u003eclientUsers\u003c/code\u003e and a \u003ccode\u003enextPageToken\u003c/code\u003e for retrieving subsequent pages.\u003c/p\u003e\n"],["\u003cp\u003eAuthorization requires the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This describes the process to list client users for a specific client via an API. It uses a `GET` request to a URL, including a required `parent` path parameter (client name). Optional query parameters `pageSize` (default 500) and `pageToken` can be used for pagination. The request body must be empty. A successful response includes a list of `clientUsers` and a `nextPageToken` for further pagination. The operation requires OAuth scope: `https://www.googleapis.com/auth/authorized-buyers-marketplace`.\n"],null,["# Method: buyers.clients.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.ListClientUsersResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all client users for a specified client.\n\n### HTTP request\n\n`GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*/clients/*}/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 name of the client. Format: `buyers/{buyerAccountId}/clients/{clientAccountId}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Requested page size. If left blank, a default page size of 500 will be applied. |\n| `pageToken` | `string` A token identifying a page of results the server should return. Typically, this is the value of [ListClientUsersResponse.nextPageToken](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.clients.users/list#body.ListClientUsersResponse.FIELDS.next_page_token) returned from the previous call to the \\[list\\]\\[users.list\\] method. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the \\[list\\]\\[users.list\\] method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-----------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"clientUsers\": [ { object (/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.clients.users#ClientUser) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `clientUsers[]` | `object (`[ClientUser](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.clients.users#ClientUser)`)` The returned list of client users. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListClientUsersRequest.pageToken](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.clients.users/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the \\[list\\]\\[users.list\\] method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/authorized-buyers-marketplace`"]]
