Method: buyers.clients.list
Stay organized with collections
Save and categorize content based on your preferences.
Lists all the clients for the current buyer.
HTTP request
GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=buyers/*}/clients
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The name of the buyer. Format: buyers/{accountId}
|
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 [ListClientsResponse.nextPageToken][nextPageToken] returned from the previous call to the [list][clients.list] method.
|
filter |
string
Query string using the Filtering Syntax Supported fields for filtering are:
Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is "1234", the value of this field should be partnerClientId = "1234", in order to get only the client whose partnerClientId is "1234" in the response.
|
Request body
The request body must be empty.
Response body
Response message for the [list][clients.list] method.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"clients": [
{
object (Client)
}
],
"nextPageToken": string
} |
| Fields |
clients[] |
object (Client)
The returned list of clients.
|
nextPageToken |
string
A token to retrieve the next page of results. Pass this value in the ListClientsRequest.pageToken field in the subsequent call to the [list][clients.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\u003eDeletes an existing client user, revoking their access to the Authorized Buyers UI which cannot be restored without creating a new user.\u003c/p\u003e\n"],["\u003cp\u003eUses an HTTP DELETE request with the specified URL format including buyer, client, and user IDs.\u003c/p\u003e\n"],["\u003cp\u003eRequires an empty request body and returns an empty response body upon successful deletion.\u003c/p\u003e\n"],["\u003cp\u003eNeeds authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"]]],["This outlines how to list clients for a buyer using an API. The `GET` request targets a specific buyer's ID via the `parent` path parameter. Optional query parameters include `pageSize`, `pageToken` for pagination, and `filter` to search by `partnerClientId`. The request body is empty. The response contains a list of clients and a `nextPageToken` for additional results. Authorization requires the `authorized-buyers-marketplace` scope.\n"],null,["# Method: buyers.clients.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.ListClientsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists all the clients for the current buyer.\n\n### HTTP request\n\n`GET https://authorizedbuyersmarketplace.googleapis.com/v1/{parent=buyers/*}/clients`\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 buyer. Format: `buyers/{accountId}` |\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 \\[ListClientsResponse.nextPageToken\\]\\[nextPageToken\\] returned from the previous call to the \\[list\\]\\[clients.list\\] method. |\n| `filter` | `string` Query string using the [Filtering Syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported fields for filtering are: - partnerClientId Use this field to filter the clients by the partnerClientId. For example, if the partnerClientId of the client is \"1234\", the value of this field should be `partnerClientId = \"1234\"`, in order to get only the client whose partnerClientId is \"1234\" in the response. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for the \\[list\\]\\[clients.list\\] method.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"clients\": [ { object (/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.clients#Client) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `clients[]` | `object (`[Client](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.clients#Client)`)` The returned list of clients. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [ListClientsRequest.pageToken](/authorized-buyers/apis/marketplace/reference/rest/v1/buyers.clients/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to the \\[list\\]\\[clients.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`"]]
