Skip to main content
GET
Returns the proposals belonging to the authenticated account. You can narrow results by status, contact, modified date, search text, and archive state. The response includes a flat array of proposal summaries and a total count, making this the standard starting point for most proposal workflows.

Authorizations

X-MSS-API-APPID
string
header
required

Portal application identifier used as part of HMAC-authenticated API requests.

X-MSS-API-USERKEY
string
header
required

Portal user API key used together with the HMAC signature headers.

X-MSS-CUSTOM-DATE
string
header
required

Timestamp header included in the signed request to prevent replay attacks.

X-MSS-SIGNATURE
string
header
required

HMAC-SHA256 signature for the request, calculated over the canonical string defined in the authentication docs.

Headers

Accept
enum<string>
required

Accept Header

Available options:
application/json

Query Parameters

SearchText
null | string

Search proposal by this text

Statuses
enum<string>[]
Available options:
Draft,
Submitted,
ViewedByClient,
Accepted,
Declined,
Delayed,
Completed,
EmailFailed,
Expired
ContactId
integer<int32>
SalespersonId
integer<int32>

Filter proposals by salesperson user ID

ModifiedAfter
string<date-time>

Modified after timestamp in UTC

SortBy
enum<string>
Available options:
CreatedDate,
ModifiedDate,
Number,
Name,
ClientName,
Status,
LastModifiedByMe
IsArchive
boolean

If true return only archived proposals otherwise return non archive proposals

SortDirection
enum<string>
Available options:
Asc,
Desc
PageNumber
integer<int32>

Page number. Starting from 1

PageSize
integer<int32>

Page Size

Response

Success

Paginated proposal list

proposals
PublicProposalModel · object[]
required

Proposals returned within the current page boundaries

proposalCount
integer<int32>
required

Total number of proposals matching the query across all pages