Returns all leads for your ConstructionOnline company account
https://api.constructiononline.com/api/Leads
This endpoint allows users to extract all current leads from their company account. This includes leads manually added or imported to ConstructionOnline, as well as leads that were captured using ConstructionOnline's Lead Capture form. Only contacts that are currently designated as "Leads" in ConstructionOnline will be returned—not any previous leads that were converted to different contact types, nor any deleted leads.
Requests
Example requests in cURL, C#, Python, and JavaScript can be found below:
cURL
# replace {email} with the email address for your ConstructionOnline account
# {password} with your ConstructionOnline password
# {apikey} with your provided API key
curl https://api.constructiononline.com/api/Leads -u {email}:{password} -H 'APIKey:{apikey}'
C#
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key */
public string GetData(string endpoint) {
string username = "{username}";
string password = "{password}";
string apikey = "{apikey}";
HttpResponseMessage response = null;
HttpClientHandler handler = new HttpClientHandler() { AutomaticDecompression = System.Net.DecompressionMethods.GZip };
using (HttpClient client = new HttpClient(handler)) {
client.Timeout = new TimeSpan(0, 0, 30);
client.BaseAddress = new Uri("http://api.constructiononline.com");
client.DefaultRequestHeaders.Accept.Clear();
client.DefaultRequestHeaders.Accept.Add(new MediaTypeWithQualityHeaderValue("application/json"));
client.DefaultRequestHeaders.Authorization = new AuthenticationHeaderValue("Basic",
System.Convert.ToBase64String(System.Text.Encoding.GetEncoding("ISO-8859-1").GetBytes(username + ":" + password)));
client.DefaultRequestHeaders.Add("APIKey", apikey);
client.DefaultRequestHeaders.Add("Accept-Encoding", "gzip");
response = client.GetAsync(endpoint).Result;
}
return response?.Content.ReadAsStringAsync().Result;
}
MessageBox.Show(GetData("api/Leads"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
import base64, requests, json
apikey = "{apikey}"
username = "{username}"
password = "{password}"
def makeRequest(endpoint):
url = "https://api.constructiononline.com/" + endpoint
userPass = username + ":" + password
headers = {
"APIKey": apikey,
"Accept-Encoding": "gzip, deflate, br",
"Authorization": "Basic " + base64.b64encode(userPass.encode()).decode(),
}
response = requests.get(url, headers=headers)
return json.dumps(json.loads(response.text), indent=2)
#Main Program
print(makeRequest("api/Leads"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key */
username = '{username}';
password = '{password}';
apikey = '{apikey}';
function makeRequest(endpoint) {
auth = btoa('${username}:${password}');
var myHeaders = new Headers();
myHeaders.append("APIKey", apikey);
myHeaders.append("Accept-Encoding", "gzip, deflate, br");
myHeaders.append("Authorization", "Basic ${auth}");
var requestOptions = {
method: 'GET',
headers: myHeaders,
redirect: 'follow'
};
fetch("https://api.constructiononline.com/" + endpoint, requestOptions)
.then(response => response.text())
.then(result => console.log(result))
.catch(error => console.log('error', error));
return response;
};makeRequest("api/Leads");
Responses
200: Success
A successful request will return a 200 response with the requested leads in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 1236709,
"FIRSTNAME": "George",
"LASTNAME": "Darsy",
"EMAIL": "gdarsy@cafedarsy.com",
"ACCOUNT": null,
"LACCESS": "2023-11-15T15:12:37.753",
"LMOD": "2023-12-7T11:43:26.237",
"DISPLAY_NAME": "George Darsy",
"COMPANY": "Cafe Darsy",
"ADDRESS": "",
"CITY": "Atlanta",
"STATE": "GA",
"ZIP": "30033",
"PHONE": "",
"MOBILE_PHONE": "3341111111",
"MOBILE_PROVIDER": "",
"FAX": "",
"LMOD_CON_ID": 987871,
"LMOD_NAME": "",
"ISCOMPANY": false,
"MIDDLENAME": "",
"WEBSITE": "",
"CREATOR_ID": 987871,
"CREATOR_NAME": "",
"TIMEZONE_OFFSET": 0.0,
"AUTO_TIMEZONE": true,
"COMPANY_ID": null,
"COMPANY_NAME": "",
"COUNTRY_SETTING": 1,
"LANGUAGE_SETTING": 1,
"LAT": null,
"LON": null,
"CS_LMOD": null,
"COMPANY_PERMISSIONS": 0,
"IS_COMPANY_ADMIN": false,
"OFFLINE_FILES": null,
"FAVORITE_PROJECTS": null,
"DATE_FORMAT": 0,
"TIME_FORMAT": 0,
"TIMEZONE_ID": null,
"CONTACT_QUALITY": 4,
"CONTACT_REGION": 0,
"CONTACT_DIVISION": 0,
"CONTACT_OFFICE": 0,
"CONTACT_CATEGORY": 0,
"CONTACT_TRADE": 0,
"FIELD_ID": 0,
"MESSAGE_SIGNATURE": null,
"ISTRIAL": 0,
"GENERAL_CALENDAR_COLOR": "#dfecf5",
"LEAD_STAGE": 0,
"LEAD_STATUS": 0,
"LEAD_QUALITY": 0,
"LEAD_VALUE": 0.00,
"LEAD_ASSIGNED_TO": null,
"LEAD_PROBABILITY": null,
"LEAD_SOURCE": 0,
"LEAD_TYPE": 0,
"LEAD_LAST_CONTACT": "2023-06-15T10:12:37.763",
"LEAD_DATE_CREATED": "2023-06-15T15:12:37.763",
"LEAD_OPENED": null,
"LEAD_CLOSED": null,
"LEAD_WON_REASON": 0,
"LEAD_LOST_REASON": 0,
"LEAD_CREATED_BY": 987871,
"LEAD_LMOD_DATE": "2023-06-15T00:00:00",
"LEAD_LMOD_ID": 987871,
"IS_LEAD": 1,
"IS_SUB": 0,
"IS_CLIENT": 0
}
404: Error
The server was not able to locate the resource specified in the request.
429: Error
The user has surpassed the request rate limit for the hour, day, week, or month.
500: Error
There was an internal server error and the server was unable to complete the request.
Last updated: Dec 7, 2023