get-lead-type-list.md

Get Lead Type List

{% api-method method="post" host="[PlatformAddress]/api/1.0/" path="crm?action=getLeadTypeList" %} {% api-method-summary %} Get Lead Type List {% endapi-method-summary %}

{% api-method-description %} Get a list of lead types. {% endapi-method-description %}

{% api-method-spec %} {% api-method-request %}

{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %}

{% endapi-method-response-example-description %}

{
    "meta": {
        "totalResults": 1,
        "start": 0,
        "perPage": 10,
        "count": 1
    },
    "results": [
        {
            "id": 1,
            "type": "Reseller",
        }
    ]
}

{% endapi-method-response-example %} {% endapi-method-response %} {% endapi-method-spec %} {% endapi-method %}

The result from this call will be a collection of all the lead types the user has access to. This call also accepts the pagination and filter properties.