GET /proposal/{ProposalId}

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

Retrieves the last revision of the specified proposal with all related data such as deals, and notes.

Path parameters

The following table lists the path parameter for the GET /proposal/{ProposalId} endpoint.

Property Required? Value Type Description
ProposalId Required Integer The unique ID of the proposal that you want to retrieve.

Response example

A successful response to a GET /proposal/{ProposalId} request returns a Proposal object.

{
    "ProposalId": 1234,
    "DisplayName": "Test Proposal",
    "RevisionNumber": 3,
    "LastActivatedRevisionNumber": 2,
    "Buyer": {
        "BuyerId": "5168"
    },
    "Seller": {
        "SellerId": "Test",
        "SellerName": "Test Seller"
    },
    "Deals": [
        {
            "DealId": 5367297813,
            "DisplayName": "Test Deal",
            "ExternalDealId": "4263497813",
            "PublisherIds": [
                "1234"
            ],
            "DealType": "Preferred",
            "PreferredDealTerms": {
                "RateType": "CPM",
                "Rate": {
                    "Amount": 0.05,
                    "CurrencyCode": "USD"
                }
            },
            "CreativeRestrictions": {
                "CreativeFormat": "Display"
            },
         "CreateTime": "2021-08-19T18:53:18.05",
         "UpdateTime": "2021-08-19T18:53:18.05"
        }
    ],
    "Notes": [],
    "Originator": "Seller",
    "LastUpdatedBy": "Seller",
    "ProposalState": "Proposed",
    "SellerAccepted": "false",
    "BuyerAccepted": "false",
    "CreatedTime": "2021-08-19T18:53:18.05",
    "UpdatedTime": "2021-08-20T23:01:41.05"
}

For details on the individual properties, see Proposal object and Deals object.

Error codes and messages

The following table provides a list of common errors and their respective HTTP error codes.

HTTP Code Status Description
404 Not Found The proposal or revision does not exist.
410 Gone The proposal has been deleted by the buyer or seller.