Skip to main content
GET
/
public
/
proposals
/
{ProposalId}
/
changeorders
curl -i -X GET \
  'https://api.portal.io/public/proposals/123/changeorders' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'

[
  {
    "id": 42,
    "number": 1,
    "name": "Change Order 1",
    "status": "Draft",
    "total": {
      "changeOrderTotal": 1250.00,
      "currency": {
        "code": "USD",
        "symbol": "$"
      }
    },
    "customer": {
      "id": 101,
      "partyType": "Person",
      "contactType": "Client",
      "firstName": "Jane",
      "lastName": "Smith",
      "companyName": null,
      "contactEmail": "jane@example.com",
      "contactPhone": "555-867-5309"
    },
    "createdDate": "2026-04-01T10:00:00Z",
    "lastModifiedDate": "2026-04-05T14:30:00Z",
    "lastModifiedByUserDate": "2026-04-05T14:30:00Z"
  }
]
Use this endpoint to retrieve all change orders associated with a proposal. The response is an array of change order summary objects, each including the change order’s status, financial total, currency, customer contact information, and creation and modification timestamps. Use the id from this list to fetch full change order details with the Get Change Order endpoint. 
curl -i -X GET \
  'https://api.portal.io/public/proposals/123/changeorders' \
  -H 'Accept: application/json' \
  -H 'X-MSS-API-APPID: YOUR_APP_ID' \
  -H 'X-MSS-API-USERKEY: YOUR_USER_KEY' \
  -H 'X-MSS-CUSTOM-DATE: Mon, 06 Apr 2026 00:22:19 GMT' \
  -H 'X-MSS-SIGNATURE: BASE64_SIGNATURE'

[
  {
    "id": 42,
    "number": 1,
    "name": "Change Order 1",
    "status": "Draft",
    "total": {
      "changeOrderTotal": 1250.00,
      "currency": {
        "code": "USD",
        "symbol": "$"
      }
    },
    "customer": {
      "id": 101,
      "partyType": "Person",
      "contactType": "Client",
      "firstName": "Jane",
      "lastName": "Smith",
      "companyName": null,
      "contactEmail": "jane@example.com",
      "contactPhone": "555-867-5309"
    },
    "createdDate": "2026-04-01T10:00:00Z",
    "lastModifiedDate": "2026-04-05T14:30:00Z",
    "lastModifiedByUserDate": "2026-04-05T14:30:00Z"
  }
]

Headers

​
Accept
enum<string>
required

Accept Header

Available options:
application/json
​
X-MSS-API-APPID
string
required

Application Id

​
X-MSS-CUSTOM-DATE
string
required

A date timestamp of the request

​
X-MSS-SIGNATURE
string
required

A signature for the request

​
X-MSS-API-USERKEY
string
required

User API Key

Path Parameters

​
ProposalId
integer<int32>
required

Proposal Id.

Response

Success

​
id
integer<int32>
required

Unique numeric identifier of the change order

​
number
integer<int32>
required

Change-order number shown to the dealer in the UI

​
name
string
required

Display name of the change order

​
status
enum<string>
required

Current change-order status

Available options:
Undefined,
Draft,
Submitted,
ViewedByClient,
Accepted,
Declined,
Delayed,
Completed,
EmailFailed,
Expired
​
createdDate
string<date-time>
required

UTC timestamp when the change order was created

​
lastModifiedDate
string<date-time>
required

UTC timestamp when the change order was last modified by the system or a user

​
total
PublicChangeOrderTotalModel · object

Change-order total amount and currency

​
customer
PublicContactModel · object

Contact summary model

​
lastModifiedByUserDate
string<date-time>

UTC timestamp when the change order was last modified by a user action