Get List Contacts

Users can get the list contacts by using our API.

Request Type:

GET/POST

Scope required

ZohoCampaigns.contact.READ

Other alternative scopes

ZohoCampaigns.contact.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

Request URL:

https://campaigns.zoho.com/api/v1.1/getlistsubscribers

API Limit

Duration: 5 mins
Number of Calls: 500
Lock Period: 30 mins

You can send 500 API calls per 5 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of Parameters --Version 1.1

Parameter	Data Type	Description
listkey*	String	List Key to send a subscription mail to contacts.
resfmt	String	XML (or) 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 contacts details.Please try after sometime.

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

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/getlistsubscribers?resfmt=XML&listkey=[listkey]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[active/recent/mostrecent/unsub/bounce]

Sample Response

Copied<response uri="/api/v1.1/getlistsubscribers" version="1.1">
	<status>success</status>
	<code>0</code>
	<sort>Ascending Order</sort>
	<range>5</range>
	<status>active</status>
	<fromindex>1</fromindex>
	<list_details>
		<fl val="ispublic">true</fl>
		<fl val="noofcontacts">960</fl>
		<fl val="listname">100</fl>
	</list_details>
	<result_of_subscribers>
		<contact>
			<fl val="phone"/>
			<fl val="firstname"/>
			<fl val="zuid">4158867</fl>
			<fl val="contact_email">user4800@thandora.com</fl>
			<fl val="companyname"/>
			<fl val="lastname"/>
		</contact>
		<contact>
			<fl val="phone"/>
			<fl val="firstname"/>
			<fl val="zuid">4158867</fl>
			<fl val="contact_email">user4449@thandora.com</fl>
			<fl val="companyname"/>
			<fl val="lastname"/>
		</contact>
		<contact>
			<fl val="phone"/>
			<fl val="firstname"/>
			<fl val="zuid">4158867</fl>
			<fl val="contact_email">user4448@thandora.com</fl>
			<fl val="companyname"/>
			<fl val="lastname"/>
		</contact>
		<contact>
			<fl val="phone"/>
			<fl val="firstname"/>
			<fl val="zuid">4158867</fl>
			<fl val="contact_email">user4447@thandora.com</fl>
			<fl val="companyname"/>
			<fl val="lastname"/>
		</contact>
		<contact>
			<fl val="phone"/>
			<fl val="firstname"/>
			<fl val="zuid">4158867</fl>
			<fl val="contact_email">user4445@thandora.com</fl>
			<fl val="companyname"/>
			<fl val="lastname"/>
		</contact>
	</result_of_subscribers>
</response>

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/v1.1/getlistsubscribers?resfmt=JSON&listkey=[listkey]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[active/recent/mostrecent/unsub/bounce]

Sample Response

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