v1
latestOpenAPI 3.0.12026-07-24501176.6 MBSearch lead
get/leads?{input params}={param values}
Query parameters
typestring
Fetch by lead type.
limitstring
Limit the number of results to be fetched
orgSourceIdstring
Specify the source account id from which you want to fetch the leads.
userIdstring
Fetch the leads of a specific user
statusstring
Fetch leads by status.
substatusstring
Fetch leads with a specific sub-status
offsetstring
The starting index for data retrieval.
sortBystring
Lets you sort the list by createdon or lastUpdatedOn
sortOrderstring
Sort the results in ascending (ASC) or descending (DESC) order
Response
200
Example response
{
"data": [
{
"id": 1,
"userId": 368754334,
"type": "SKU",
"leadFor": "item001",
"status": "WON",
"nextFollowUp": "2018-10-05T08:00:00+05:30",
"createdOn": "2018-10-04T13:30:00+05:30",
"createdBy": 28812689,
"lastUpdatedOn": "2018-11-14T15:44:26+05:30",
"lastUpdatedBy": 15002926,
"followUpDetails": [
{
"id": 1,
"userId": 368754334,
"leadId": 1,
"notes": "notes 1",
"createdBy": 15002926,
"createdOn": "2018-11-14T15:38:04+05:30",
"followedUpBy": 28812689,
"followedUpOn": "2018-10-04T12:45:00+05:30",
"scheduledFollowUp": "2018-10-04T12:30:00+05:30"
}
],
"statusLogDetails": [
{
"id": 1,
"userId": 368754334,
"leadId": 1,
"status": "OPEN",
"createdBy": 15002926,
"createdOn": "2018-11-14T15:38:04+05:30",
"reasonId": 5,
"reason": "Best price available at another store"
}
],
"orgSourceId": -1
}
]
}