Get list leads

Using this API, you can get the leads of a list. Along with the leads, you'll also get the entire detail about each lead.

Scope required

  • ZohoMarketingAutomation.lead.READ

Other alternative scopes

  • ZohoMarketingAutomation.lead.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

Request type:

  • Get/ Post

Request URL

https://marketingautomation.zoho.com/api/v1/getleads

List of parameters

Parameter

Data type

Description

listkey*

String

List Key to send a subscription mail to leads.

resfmt

String

JSON

sort

String

asc/desc

fromindex

Number

values are in number.

range

Number

values are in number.

status

String

active/ recent/ most recent/ unsub/ bounce.

* - Mandatory parameters

Possible error cases

Error code

Description

1004

Unable to find the resource you're looking for. Please recheck the documentation and try again.

2704

Insufficient privilege to access other users' mailing list.

2701

Insufficient privilege to access your mailing list.

2501

Listkey is empty or invalid.

2203

This list has been deleted.

2502

Error in displaying leads details.Please try after sometime.

If your error code is not listed above, click here.

Sample request


				https://marketingautomation.zoho.com/api/v1/getleads?resfmt=JSON&listkey=[listkey]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[active/recent/mostrecent/unsub/bounce]			

Sample response


				{
"requestdetails": {
"sort": "Ascending Order",
"range": 5,
"status": "active",
"fromindex": 1
},
"status": "success",
"list_of_details": [
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4800@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4449@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4448@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4447@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
},
{
"phone": "",
"zuid": "4158867",
"lead_email": "user4445@thandora.com",
"lastname": "",
"firstname": "",
"companyname": ""
}
],
"code": "0",
"uri": "/api/v1/getleads",
"version": "1"
}