Get Lead List

Get Lead List

POST [PlatformAddress]/api/1.0/crm?action=getLeadList

Get a list of lead.

Path Parameters

Name	Type	Description
	string

200

{
    "meta": {
        "totalResults": 1,
        "start": 0,
        "perPage": 100,
        "count": 1
    },
    "results": [
        {
            "id": 763,
            "name": "Lead Name",
            "description": "This is test description",
            "ownerUser": {
                    "id": 549,
                    "firstName": "First",
                    "lastName": "Last",
                    "email": "[e-mail]",
                    "phone": ""
            },
            "contact": {
                    "id": 580,
                    "firstName": "First",
                    "lastName": "last",
                    "email": "[e-mail]",
                    "phone": 614535435
            },
            "company": {
                    "id": 214,
                    "businessName": "Company BusinessName",
                    "businessNumber": "BUS123",
                    "phone": null,
                    "email": [e-mail]
            },
            "currentBookingId": 5,
            "qualityId": 2,
            "quality": "B-Grade",
            "stageId": 47,
            "stageName": "Interested",
            "stageReasonId": 245,
            "stageReasonName": "Price under budget",
            "adminStatusChangedDate": "2019-04-12 11:11:00 UTC",
            "typeId": 3,
            "type": "Reseller",
            "sourceId": 13,
            "sourceName": "Newspaper",
            "channelId": 8,
            "channelName": "PCO",
            "leadBccEmail": "[e-mail]",
            "closedDate": "2019-04-19 09:00:00 UTC",
            "lostToCompetition": "More capacity available",
            "createdDate": "2019-04-12 09:00:35 UTC",
            "modifiedDate": "2019-04-12 11:11:00 UTC"
        }
    ]
}

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