GET /proposal/query/facets

NOTE: The EPA API has sunset on September 30, 2026. Endpoints are no longer accessible. For alternatives, see EPA to PDP Migration.

Retrieves a list of facets that you can use to look up proposals with the POST /proposal/query endpoint.

Response example

A successful response to a GET /proposal/query/facets request returns a ProposalQueryFacets object.

{
    "ProposalStates": [
        {
            "Value": "Proposed",
            "DisplayName": "Proposed"
        },
        {
            "Value": "Accepted",
            "DisplayName": "Accepted"
        },
        {
            "Value": "Activated",
            "DisplayName": "Activated"
        },
        {
            "Value": "Rejected",
            "DisplayName": "Rejected"
        }
    ],
    "DealTypes": [
        {
            "Value": "Guaranteed",
            "DisplayName": "Guaranteed Deal"
        },
        {
            "Value": "Preferred",
            "DisplayName": "Preferred Deal"
        },
        {
            "Value": "PrivateAuction",
            "DisplayName": "Private Auction"
        }
    ],
    "SortingFields": [
        {
            "Value": "ProposalId",
            "DisplayName": "Proposal ID"
        },
        {
            "Value": "Name",
            "DisplayName": "Name"
        },
        {
            "Value": "ProposalState",
            "DisplayName": "Proposal State"
        },
        {
            "Value": "CreateTime",
            "DisplayName": "Creation Time"
        },
        {
            "Value": "UpdateTime",
            "DisplayName": "Update Time"
        }
    ]
}

Response object properties

The following table lists the GET /proposal/query/facets response object properties.

Property	Required?	Value Type
`ProposalStates`	Object Array	The list of proposal states. Possible values include the following: `Proposed` `Accepted` `Rejected` `Activated`
`DisplayName`	String	A user-friendly name for the value.
`DealTypes`	Object Array	The list of deal types. For object properties, see Deal Type object. See also Easy Proposal Activation API.
`SortFields`	Object Array	The list of proposal fields by which the search results can be sorted in a query. For object properties, see Sort Field object.

Deal Type object

The following table lists the DealTypes object properties.

Property	Required?	Value Type	Description
`Value`	String	The value of the facet type. Possible values include the following: `Guaranteed` `Preferred` `PrivateAuction`
`DisplayName`	String	A user-friendly name for the value.

Sort Field object

The following table lists the SortFields object properties.

Property	Required?	Value Type	Description
`Value`	String	The value of the facet type. Possible values include the following: `ProposalId` `DisplayName` `ProposalState` `CreateTime` `UpdateTime`
`DisplayName`	String	A user-friendly name for the value.