Prospecting Events
Access Point: /api.1.1.0/prospecting/get_leads.json
HTTP Method: GET|POST
Description: Get the list of leads received within a fixed period of time. The number of leads is limited to 100. If you get exactly 100 leads from this access point, you should reduce the length of the time period.
The list is sorted by the date & time of the first transfer done for each lead.
Be aware that even the response of this access points includes the contact information of the lead, more information may be appended after the transfer. So, use /api.1.1.0/prospecting/get_data.json or /api.1.1.0/prospecting/get_latest_data.json, to grab contact infromation appended after the lead transfer.
Params:
api_key: You can get yor API key here: https://connectionsphere.com/member/clientinformation
from_time: Data time value, with the format YYYYMMDDHHMMSS. The localization of this time value must be GMT+1.
to_time: Data time value, with the format YYYYMMDDHHMMSS. The localization of this time value must be GMT+1.
Success Response:
{"status":"success","value":Array of Hashes}
The value has an array of hashes. Each has has the information of one different lead.
The format of each has is like below:
{
"pipeline_id":"1E597CCF-2C72-4004-BA9F-BE663F3F917E",
"profile_id":"7D253EE9-9957-4726-8F24-554BB934B025",
"profile_name":"Joshua Rivera",
"profile_headline":"American Entreprenuer, NBA Free Agent",
"profile_location":"Thousand Oaks, California",
"profile_industry":null,
"profile_linkedin_url":https://linkedin.com/in/joshua-rivera-77*****0,
"first_transfer_date_time":"20190204042939",
"data":[
{
"append_id":"18487698-C5E9-4161-A9E3-202341802FEB",
"profile_id":"7D253EE9-9957-4726-8F24-554BB934B025",
"append_type":"10",
"append_value":"805*****2"
},
{
"append_id":"C77F5D05-E87F-42CC-B891-EB8CA7140155",
"profile_id":"7D253EE9-9957-4726-8F24-554BB934B025",
"append_type":"20",
"append_value":"jos*****@gmail.com"
},
{
"append_id":"F91AAE1F-0779-4F3E-A922-1BD0755410E8",
"profile_id":"7D253EE9-9957-4726-8F24-554BB934B025",
"append_type":"90",
"append_value":"https://www.linkedin.com/in/joshua-********2560"
}
]
}
The values for append_type can be:
TYPE_PHONE = 10
TYPE_FAX = 14
TYPE_EMAIL = 20
TYPE_TWITTER = 30
TYPE_FACEBOOK = 40
TYPE_LANGUAGE = 50
TYPE_SIC = 60
TYPE_NAICS = 70
TYPE_ADDRESS = 80
TYPE_LINKEDIN = 90
TYPE_WEBSITE = 100
TYPE_CELL = 112
TYPE_SKYPE = 140
TYPE_LOCATION = 1010
TYPE_INDUSTRY = 1020
TYPE_INSIGHT = 1030
Error Response:
{"status":"error","value":string}
Error values:
"api_key parameter expected": Parameter not received. You probably didn't add it into the call, or its name is wrong spelled.
"from_time parameter expected": Parameter not received. You probably didn't add it into the call, or its name is wrong spelled.
"to_time parameter expected": Parameter not received. You probably didn't add it into the call, or its name is wrong spelled.
"invalid api_key": The api_key param has a wrong format.
"invalid from_time": The from_time param has a wrong format.
"invalid to_time": The to_time param has a wrong format.
"api_key not found": There is not client with such API key in the division where you are calling (in this example, the division is euler.connectionsphere.com). The API key is wrong or you may call another URL (example: copernico.connectionsphere.com).
"from_time must be lower than to_time": The from_time is equal of higher than to_time.
Access Point: /api.1.1.0/prospecting/get_latest_leads.json
HTTP Method: GET|POST
Description: Get the list of latest leads transferred during a last period of time. The number of records is limited to 100. If you get exactly 100 leads from this access point, you should reduce the length of the time period.
Params:
api_key: You can get yor API key here: https://connectionsphere.com/member/clientinformation
period: Optional. It's a char D (days), W (weeks), M (months) or Y (years). It's W by default.
units: Optional. May be a number higher than 0. Example: 2 (days, weeks, months or years). It's 1 by default
id_pipeline: Optional. To bring results of a certain pipeline. It's null by default.
warm_leads_only: Optional. To bring leads who have replied positively to any message. It's "yes" by default.
Access Point: /api.1.1.0/prospecting/get_latest_data.json
HTTP Method: GET|POST
Description: Get the list of latest information appended during a last period of time. The number of records is limited to 100. If you get exactly 100 leads from this access point, you should reduce the length of the time period.
Params:
api_key: You can get yor API key here: https://connectionsphere.com/member/clientinformation
period: Optional. It's a char D (days), W (weeks), M (months) or Y (years). It's W by default.
units: Optional. May be a number higher than 0. Example: 2 (days, weeks, months or years). It's 1 by default
id_pipeline: Optional. To bring results of a certain pipeline. It's null by default.
data_type: Optional. It's the kind of information that you want to receive. It's an integer 20 (emails), 10 (phone numbers) or 90 (LinkedIn URLs). It's null by default, and will return all the information, from any type.
verified: Optional. You can specify if you want the information has been verified or not. Possible values are yes or no. It's null by default, and will return either verified and not verified information.
warm_leads_only: Optional. To bring leads who have replied positively to any message. It's "yes" by default.