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

Get Prospect Statuses

Owned by Kun Liu (Unlicensed)
Last updated: Oct 21, 2014 by Kurt Wagner (Unlicensed)
3 min read

UNDER DEVELOPMENT

Returns an array of statuses of prospects.

GET /prospects/statuses

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.

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 for the status
titlestringThe status title
parentunsigned intThe id of the parent status.
orderingintThe ordering number for the status
colorstringThe color of the status

Sample Response

GET /prospects/statuses.json?_limit=2&_fields=color
{
    "response": [
        {
            "color": "orange",
            "id": "1",
            "title": "New Signup"
        },
        {
            "title": "Investment Pass",
            "color": "red",
            "id": "61"
        },
        {
            "id": "5",
            "color": "red",
            "title": "Cancelled"
        },
        {
            "color": "grey",
            "id": "6",
            "title": "Abandoned"
        },
        {
            "title": "Pitched Informally",
            "id": "47",
            "color": "yellow"
        },
        {
            "color": "pink",
            "id": "9",
            "title": "Sell"
        },
        {
            "color": "darkblue",
            "id": "56",
            "title": "Custdev"
        },
        {
            "title": "Introduced",
            "color": "red",
            "id": "49"
        },
        {
            "id": "58",
            "color": "yellow",
            "title": "Quoted"
        },
        {
            "title": "Verbally Approved",
            "id": "59",
            "color": "blue"
        }
    ],
    "meta": {
        "status": "ok",
        "message": "Everything executed as expected.",
        "more_info": "https://affinitylive.jira.com/wiki/display/APIS/Status+Codes#ok"
    }
}