- style
Get Prospect types
Under development
Returns an array of types of prospects.
GET /prospects/typesParameters
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 |
_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 for the type |
|---|---|---|
title | string | The type title |
parent | unsigned int | The id of the parent type. |
ordering | int | The ordering number for the type |
Sample Response
GET /prospects/types.json?_limit=2&_fields=ordering{
"response": [
{
"id": "21",
"title": "Customization",
"ordering": "4"
},
{
"id": "13",
"title": "Partner",
"ordering": "4"
},
{
"title": "AffinityLive",
"id": "24",
"ordering": "6"
},
{
"id": "25",
"title": "Investor",
"ordering": "7"
},
{
"ordering": "8",
"id": "26",
"title": "Affiliate"
},
{
"id": "39",
"title": "Website Sale",
"ordering": "13"
},
{
"ordering": "14",
"title": "Partner Marketing",
"id": "40"
},
{
"id": "41",
"title": "Cold Call Opportunity",
"ordering": "15"
}
],
"meta": {
"message": "Everything executed as expected.",
"more_info": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok",
"status": "ok"
}
}