Lead Lists API

Lead Lists API

If you have your own system and would like to get your lead lists or a specific list data without our dashboard, we have just created an API allowing you to do just that. This API is for server-to-server communication, in case you have your own CRM system or something similar to manage your customer base.

 

Url: https://mcpn.us/limeApi?ev=leadLists

 

You must supply one of the following parameters: listid / all / keyword

 

Parameters (case sensitive, bold are mandatory):

Parameter Name (Case Sensitive)	Value	Description	Default Value
user	Advertiser username	The advertiser’s username that matches the api_id	None
api_id	Advertiser Api Id	The advertiser’s api_id that matches the username	Generated from edit profile
listid	Number	List Id	The list id for lookup
keyword	Text	Full keyword to search the lead list that connects to this keyword. i.e. pizza (71441-US)
all	true	To get a list of all your listings

 

Return Code 

If the API succeeds then it will return with status code 200 with xml

If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response.

 

If an error occurs or there is an invalid parameter then it returns with status code 400 or 500 with an error message in the response. 

 

Example: 

http://login.limecellular.com/limeApi?ev=leadLists&user=adv@gmail.com&api_id=a4HI43WyFK83821B&listid=3958

 

 

XML:

 

If it's one listing lookup that is answer to the parameters: listed or keyword than the XML will be with one listing:

 

<?xml version="1.0" encoding="UTF-8"?>

<listing>

<id>1453</id>

<name>Web Site</name>

<keyword>zm85 (71441-US)</keyword>

<message>

Thank you for contacting us! One of our representatives will call you back shortly.

</message>

<profileGrabber>false</profileGrabber>

<alternativeReply/>

<responseUrl></responseUrl>

<responseUrlMethod></responseUrlMethod>

<waitForOK>false</waitForOK>

<adfEmail/>

<coupon>25672</coupon>

<sendToMyEmail>true</sendToMyEmail>

<notifyEmail/>

<notifyNumber/>

</listing>

 

 

If it's a group of listing lookup that is answer to the parameter: all than the XML will be with list of listing:

 

<?xml version="1.0" encoding="UTF-8" ?>

<?xml version="1.0" encoding="UTF-8"?>

<leadLists>

<listing>

<id>1453</id>

<name>Web Site</name>

<keyword>zm85 (71441-US)</keyword>

<message>

Thank you for contacting us! One of our representatives will call you back shortly.

</message>

<profileGrabber>false</profileGrabber>

<alternativeReply/>

<responseUrl></responseUrl>

<responseUrlMethod></responseUrlMethod>

<waitForOK>false</waitForOK>

<adfEmail/>

<coupon>25672</coupon>

<sendToMyEmail>true</sendToMyEmail>

<notifyEmail/>

<notifyNumber/>

</listing>

 

 

<listing>

<id>1457</id>

<name>Web Site 2</name>

<keyword>ab78 (71441-US)</keyword>

<message>

Thank you for contacting us! One of our representatives will call you back shortly.

</message>

<profileGrabber>false</profileGrabber>

<alternativeReply/>

<responseUrl></responseUrl>

<responseUrlMethod></responseUrlMethod>

<waitForOK>false</waitForOK>

<adfEmail/>

<coupon>25672</coupon>

<sendToMyEmail>true</sendToMyEmail>

<notifyEmail/>

<notifyNumber/>

</listing>

<leadLists>