Returns all opportunities for your ConstructionOnline company account
https://api.constructiononline.com/api/Opportunities
This endpoint allows users to obtain important opportunity data from their company account. Using this endpoint, users can extract their current opportunity record from ConstructionOnline, which consists of all active opportunities within their company account. Note that this does not include any deleted opportunities, opportunities that were converted to projects, or information on 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/Opportunities -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/Opportunities"));
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/Opportunities"))
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/Opportunities");
Responses
200: Success
A successful request will return a 200 response with the requested opportunities in the body, as seen below. Definitions for all returned properties can be found here.
{
"ID": 4412849,
"NAME": "1342 S Ross St - version w/out pool",
"CREATED_BY": 985000,
"CREATOR_NAME": "Alice Conway",
"LMOD": "2023-11-13T17:21:27.20",
"ADDRESS": "2562 Moores Mill Rd",
"CITY": "Auburn",
"STATE": "AL",
"ZIP": "36830",
"PROJECT_NUMBER": "",
"LMOD_CON_ID": 985612,
"IS_ARCHIVED": false,
"CURRENCY": 0,
"IS_TEMPLATE": true,
"COUNTRY_SETTING": 1,
"CUSTOM_COLOR": "#f7b9d6",
"COMPANY_ID": 24720,
"COMPANY_NAME": "",
"IS_INACTIVE": false,
"ADDR_LAT": 56.000000,
"LAT": 56.000000,
"ADDR_LON": 50.000000,
"LON": 50.000000,
"SCOPE_OF_WORK": "",
"TOTAL_TIME": 0,
"TOTAL_MONEY": 0.0,
"PROJECT_NOTES": "",
"NUMBERFOLDERS": 4,
"NUMBERIMAGES": 1,
"NUMBERALBUMS": 1,
"NUMBERFILES": 2,
"DATE_CREATED": "2023-08-03T15:30:38.56",
"PROJECT_TYPE_ID": 0,
"PROJECT_TYPE": "Single-family Residential",
"ATTACH_FOLDER_ID": null,
"ESTIMATE_UNQUALIFIED_COMMITS": null,
"ESTIMATE_UNQUALIFIED_ACTUALS": null,
"ESTIMATE_UNQUALIFIED_EXPENSES": null,
"SELECTION_UNQUALIFIED_COMMITS": null,
"SELECTION_UNQUALIFIED_ACTUALS": null,
"SELECTION_UNQUALIFIED_EXPENSES": null,
"CHANGE_ORDER_UNQUALIFIED_COMMITS": null,
"CHANGE_ORDER_UNQUALIFIED_ACTUALS": null,
"CHANGE_ORDER_UNQUALIFIED_EXPENSES": null,
"PRIMARY_SCHEDULE": null,
"COST_CODE_SET": 2,
"IS_OPPORTUNITY": true,
"OPPORTUNITY_STATUS": 3,
"OPPORTUNITY_STAGE": 2812,
"OPPORTUNITY_SOURCE": 2875,
"OPPORTUNITY_TYPE": 2880,
"OPPORTUNITY_REFERRER": "",
"OPPORTUNITY_PROBABILITY": 75,
"OPPORTUNITY_VALUE": 800000.0,
"OPPORTUNITY_OPENED_DATE": "2023-08-03T00:00:00",
"OPPORTUNITY_CLOSED_DATE": "2023-10-11T00:00:00",
"OPPORTUNITY_QUALITY": 4,
"OPPORTUNITY_NOTES": "",
"OPPORTUNITY_CONVERTED_DATE": null,
"OPPORTUNITY_LEAD": null,
"OPPORTUNITY_WON_REASON": 0,
"OPPORTUNITY_LOST_REASON": 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 27, 2023