Skip to main content

Search Proposals v2

A technical guide on searching for proposals in Accelerate using API v2, including required and optional search parameters.

Funmilola Olorode avatar
Written by Funmilola Olorode
Updated over 10 months ago

Path Parameters

HTTP Header

api-key REQUIRED

string - Your Accelerate API Key

URL Substitution

subdomain REQUIRED
string - Your Accelerate subdomain

Proposal Search Requests

POST

POST - Retrieves a list of proposals matching supplied criteria

https://{{subdomain}}.quotevineapp.com/qvine/quotevine/api/v2/proposals/search

Example Payload

POST

{
    "relationship_name":"James Michaels",
    "proposal_status": "Submitted"
}

Response

400
​

Returned if the request sent is invalid.

404
​

Returned if the request is not found or the user does not have permission to view it.

200
Returned if the request is successful.

Expand to see example of a successful response.

{
    "items": [
        {
            "proposal_id": 118045724538,
            "status": "Submitted",
            "relationship_id": 2300191,
            "legal_form": "Private Individual",
            "relationship_name": 'James',
            "relationship_status": 'Live',
            "telephone_number": null,
            "telephone_number2": null,
            "mobile_number": 07777777777,
            "email_address": [email protected],
            "date_of_birth": "2001-10-30",
            "registration_number": null,
            "vat_registration_number": null,
            "postcode": null,
            "creation_date": 15-08-2022,
            "last_update_date": 15-08-2022,
        }
    ]
}

Proposal Search Attributes

When searching Proposals via the API, there are a number of fields needed.

Mandatory Fields

Expand to see the list of mandatory fields

relationship_name - string

email_address - string

mobile_number - string
Landline numbers can also be passed in.

external_reference - string


​

Non Mandatory Fields

Expand to see the list of non-mandatory fields.

proposal_status - string
Must be one of the proposal statuses configured in Workflow Settings.

updated_since - date


​

Related Articles
Relationships v2
Relationships Search v2
Driver Object v2
Contact Object v2
Proposal Notes v2
Did this answer your question?