Get Lead List

post
Get Lead List

[PlatformAddress]/api/1.0/crm?action=getLeadList
Get a list of lead.
Request
Response
Path Parameters
optional
string
‚Äč
200: OK
{
"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": "first@last.com",
"phone": ""
},
"contact": {
"id": 580,
"firstName": "First",
"lastName": "last",
"email": "filrst.last@email.com",
"phone": 614535435
},
"company": {
"id": 214,
"businessName": "Company BusinessName",
"businessNumber": "BUS123",
"phone": null,
"email": company@owner.com
},
"currentBookingId": 5,
"qualityId": 2,
"quality": "B-Grade",
"stageId": 47,
"stageName": "Interested",
"typeId": 3,
"type": "Reseller",
"sourceId": 13,
"sourceName": "Newspaper",
"channelId": 8,
"channelName": "PCO",
"leadEmailAddress": "lead-2-763-facdb9@ivvy.blueweb",
"createdDate": "2019-04-12 09:00:35 UTC",
"modifiedDate": "2019-04-12 09:00:35 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.