The following macros are not currently supported in the header:
  • style

GET /quotes

Resource URL

Returns an array of quotes.

GET /quotes

Parameters

Table of allowed parameters.

_pageunsigned intThe page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources.
_limitunsigned intThe maximum number of resources to return. Default is 10 and maximum is 50.
_offsetunsigned intThe position in the list of resources to return from. For example, if you had 20 resources and requested an offset of 10. Resources 10 to 19 would be returned. Offset cannot be used in conjunction with _page.
_fieldspartial stringAllows you to specify optional fields and linked objects to include in the response.
_filterspartial string Filter and order list

Filtering

You can filter the returned list using the _filters parameter.

NameExampleDescription
id(<values>)id(1,2,4) 
standing(<values>)id(published)e.g

'draft','published','accepted','declined','converted','inactive'

portal_access(<value>)success(yes)e.g, yes or no
affiliation(<values>)affiliation(1,43)Accepts affiliation ids
status(<values>)status(43,7,23)Accepts prospect status ids.
date_created_before(<unix timestamp>)date_created_before(1300001115) 
date_created_after(<unix timestamp>)date_created_after(1300001115) 
date_expiry_before(<unix timestamp>)date_expiry_before(1300001115) 
date_expiry_after(<unix timestamp>)date_expiry_after(1300001115) 
min_id(<id>)  
max_id(<id>)  
manager(<ids>)manager(1,2,4)Only return quotes with the given manager ids.
against_type(<types>)against_type(prospect)Only return quotes against the given types. e.g, Prospect.
against_id(<ids>)against_id(12,32)Only return quotes against the given ids.
order_by_asc(<value>)order_by_asc(total_price)

Accepts: date_created, date_expiry, service_price_total, material_price_total, service_time_total,

total_price and id.

order_by_desc(<value>)order_by_desc(total_price)

Accepts: date_created, date_expiry, service_price_total, material_price_total, service_time_total,

total_price and id.

NEW

<field_name>_greater_than(<value>),

<field_name>_less_than(<value>),

<field_name>_greater_than_or_equal(<value>),

<field_name>_less_than_or_equal(<value>)

 

_filters=id_greater_than(5)

Available fields:

id
against_id
manager
affiliation
status
created_by
service_price_total
service_time_total
material_price_total
total_price

Using the _not suffix (e.g, id_not) on standard in filters will return results not in.

Handling the response

For information regarding handling the response, please see GET quotes/:id.