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

GET /prospects/:id

Resource URL

Returns a specific prospect object.

GET /prospects/:id

Parameters

Table of allowed parameters.

_fieldspartial stringAllows 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.

idunsigned intA unique id assigned to the prospect. This value can be used in subsequent requests to retrieve, remove or update date.
titlestringThe title assigned to the prospect.
standingstring 
date_createdunsigned int 
date_actionedunsigned int 
date_dueunsigned int 
waiting  
value  
success  
commentsstring 
contactunsigned int or object 
managerunsigned int or object 
typeunsigned int or object 
statusunsigned int or object 
prospect_probabilityunsigned int or object 
progressdecimalThe equal value of the percent of the progress, e.g. 0.5
affiliationunsigned int or objectThe 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."
   }
}