Method: buyers.proposals.list
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*}/proposals
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. Parent that owns the collection of proposals Format: buyers/{accountId}
|
Query parameters
| Parameters |
filter |
string
Optional query string using the Cloud API list filtering syntax Supported columns for filtering are:
- displayName
- dealType
- updateTime
- state
|
pageSize |
integer
Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500.
|
pageToken |
string
The page token as returned from ListProposalsResponse.
|
Request body
The request body must be empty.
Response body
Response message for listing proposals.
If successful, the response body contains data with the following structure:
| JSON representation |
{
"proposals": [
{
object (Proposal)
}
],
"nextPageToken": string
} |
| Fields |
proposals[] |
object (Proposal)
The list of proposals.
|
nextPageToken |
string
Continuation token for fetching 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 proposals, allowing filtering by displayName, dealType, updateTime, and state using Cloud API list filtering syntax.\u003c/p\u003e\n"],["\u003cp\u003eRequires authorization with the \u003ccode\u003ehttps://www.googleapis.com/auth/authorized-buyers-marketplace\u003c/code\u003e scope.\u003c/p\u003e\n"],["\u003cp\u003eUses a GET request to the endpoint \u003ccode\u003ehttps://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*}/proposals\u003c/code\u003e, with the parent specified as a path parameter.\u003c/p\u003e\n"],["\u003cp\u003eResponse includes a list of proposals and a nextPageToken for pagination.\u003c/p\u003e\n"],["\u003cp\u003eRequest body should be empty.\u003c/p\u003e\n"]]],["This describes how to list proposals via an API. It uses a `GET` request to `https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*}/proposals`, where `parent` specifies the buyer's account. Optional query parameters `filter`, `pageSize`, and `pageToken` are available. The request body should be empty. The response is a JSON containing an array of `proposals` and a `nextPageToken` for pagination. Authorization requires the `authorized-buyers-marketplace` OAuth scope.\n"],null,["# Method: buyers.proposals.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.ListProposalsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists proposals. A filter expression using [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) may be specified to filter the results.\n\n### HTTP request\n\n`GET https://authorizedbuyersmarketplace.googleapis.com/v1alpha/{parent=buyers/*}/proposals`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------|----------------------------------------------------------------------------------------------|\n| `parent` | `string` Required. Parent that owns the collection of proposals Format: `buyers/{accountId}` |\n\n### Query parameters\n\n| Parameters ||\n|-------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `filter` | `string` Optional query string using the [Cloud API list filtering syntax](https://developers.google.com/authorized-buyers/apis/guides/list-filters) Supported columns for filtering are: - displayName - dealType - updateTime - state |\n| `pageSize` | `integer` Requested page size. The server may return fewer results than requested. If unspecified, the server will put a size of 500. |\n| `pageToken` | `string` The page token as returned from ListProposalsResponse. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nResponse message for listing proposals.\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"proposals\": [ { object (/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals#Proposal) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|--------------------------------------------------------------------------------------------------------------------------------------|\n| `proposals[]` | `object (`[Proposal](/authorized-buyers/apis/marketplace/reference/rest/v1alpha/buyers.proposals#Proposal)`)` The list of proposals. |\n| `nextPageToken` | `string` Continuation token for fetching 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`"]]
