v1

latestOpenAPI 3.0.02026-07-2335196124.2 KB
Proposal

Search proposals

Search proposals

get/proposals/

Query parameters

Namestring

Proposal name

Emailstring

The bill to or sell to email

UpdatedAfterstring

The UTC date and time in ISO 8601 format

UpdatedBeforestring

The UTC date and time in ISO 8601 format

UpdatedBystring[]

The unique external system user identifier

CreatedBystring[]

The unique external system user identifier

Sourcestring

The source from where the proposal was created

CreatedAfterstring

The UTC date and time in ISO 8601 format

CreatedBeforestring

The UTC date and time in ISO 8601 format

Lockedboolean

Retrieve proposals that are locked or not

Pageinteger required

The page at which the proposals should be returned

Limitinteger required

The maximum number of proposals to return

LinkIdstring

The link id for any status

Headers

Accept'application/json' required
X-Avangate-Authenticationstring required

Authentication header

Response

OK

pageinteger required

The incoming page value

limitinteger required

The incoming limit value

proposalsCountinteger required

The total number of proposal matching the criterias

pagesCountinteger required

The total number of pages for proposal matching the criterias