Get List Subscribers

Get List Subscribers

Users can get the list subscribers by using our API.

Request URL

You've an option of using either the XML (or) JSON format at the time of request.

XML/ JSON:

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

Request Type: Get/ Post

List of Parameters

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

listkey*

String

List Key to send a subscription mail to contacts.

version

String

This will fetch responses based on the current API version.

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

Sample Request:

XML/ JSON:

https://campaigns.zoho.com/api/getlistsubscribers?authtoken=[API Authentication Token]&scope=CampaignsAPI&listkey=[listkey]&sort=[asc/desc]&fromindex=[number]&range=[number]&status=[active/recent/mostrecent/unsub/bounce]&resfmt=[XML/JSON] 

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<response uri="/api/getlistsubscribers" version="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>

JSON format:

{"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/getlistsubscribers","version":"1"}

Possible Error Cases

Error code Description
1004Unable to find the resource you're looking for. Please recheck the documentation and try again.
2704Insufficient privilege to access other users' mailing list.
2701Insufficient privilege to access your mailing list.
2501Listkey is empty or invalid. 
2203This list has been deleted.
2502Error in displaying subscribers details.Please try after sometime.

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

Share this post : FacebookTwitter

Still can't find what you're looking for?

Write to us: support@zohocampaigns.com