Resource URL

Returns a specific prospect object.

GET /prospects/:id

Parameters

Table of allowed parameters.

_fields	partial string	Allows you to specify optional fields and linked objects to include in the response.

Handling the response

Below is a table of available response fields and objects that are returned within the response object of the returned object. The optional fields and objects can be requested in the _fields parameter; see included examples. Underlined values are default.

id	unsigned int	A unique id assigned to the prospect. This value can be used in subsequent requests to retrieve, remove or update date.
title	string	The title assigned to the prospect.
standing	string
date_created	unsigned int
date_actioned	unsigned int
date_due	unsigned int
waiting
value
success
comments	string
contact	unsigned int or object
manager	unsigned int or object
type	unsigned int or object
status	unsigned int or object
prospect_probability	unsigned int or object
progress	decimal	The equal value of the percent of the progress, e.g. 0.5
affiliation	unsigned int or object	The affiliation id or the affiliation object

Fields that can be object indicate the field can be requested as a resource. For example.

GET /prospects/1?_fields=manager

would return the owner's staff id. Where as,

GET /prospects/1?_fields=manager(email)

would return the manager's staff object, including any optional fields or objects within the parenthesis. In the above examples case, it would return the managers objects default values and optional email value.

Sample Response

GET /prospects/52.json?_fields=status(),standing,contact

{
   "response" : {
         "standing" : "active",
         "status" : {
            "id" : "52",
            "title" : "Unknown"
         },
         "title" : "Affinigravity",
         "id" : "4",
         "contact" : "13283"
      },
   eta" : {
      "status" : "ok",
      "message" : "Everything executed as expected."
   }
}