Returns an array of prospects.
GET /prospects |
Table of allowed parameters.
_page | unsigned int | The page of the list to display. For example, 5 will display the fifth page. Each page contains 10 resources. |
---|---|---|
_limit | unsigned int | The maximum number of resources to return. Default is 10 and maximum is 50. |
_offset | unsigned int | The 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 . |
_fields | partial string | Allows you to specify optional fields and linked objects to include in the response. |
_filters | partial string |
You can filter the returned list using the _filters
parameter.
Name | Example | Description |
---|---|---|
id(<values>) | id(1,2,4) | |
standing(<values>) | id(won) | e.g unassigned, active, won, lost, cancelled, abandoned |
weighting(<values>) | ||
success(<value>) | success(yes) | e.g, yes or no |
affiliation(<values>) | affiliation(1,43) | Accepts affiliation ids |
type(<values>) | type(43,5) | Accepts prospect type ids. |
status(<values>) | status(43,7,23) | Accepts prospect status ids. |
prospect_probability(<values>) | prospect_probability(32,43) | Accepts prospect probability ids. |
company | company(1,4) | Accepts company ids. |
date_created_before(<unix timestamp>) | date_created_before(1300001115) | |
date_created_after(<unix timestamp>) | date_created_after(1300001115) | |
date_actioned_before(<unix timestamp>) | date_actioned_before(1300001115) | |
date_actioned_after(<unix timestamp>) | date_actioned_after(1300001115) | |
date_due_before(<unix timestamp>) | date_due_before(1300001115) | |
date_due_after(<unix timestamp>) | date_due_after(1300001115) | |
min_id(<id>) | ||
max_id(<id>) | ||
order_by_asc(<type>), order_by_desc(<type>) | order_by_desc(id) | Accepts: id, date_actioned and date_created. date_due, title, status, standing and date_last_interacted |
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 |
Using the |
For information regarding handling the response, please see GET prospects/:id.
GET /prospects.json?_fields=status(),standing,contact |
{ "response" : [ { "standing" : "active", "status" : { "id" : "52", "title" : "Unknown" }, "title" : "Affinigravity", "id" : "4", "contact" : "13283" }, { "standing" : "active", "status" : { "id" : "52", "title" : "Unknown" }, "title" : "Affinity", "id" : "6", "contact" : "13089" } ], "meta" : { "status" : "ok", "message" : "Everything executed as expected." } } |