Returns all opportunities within your ConstructionOnline company account that were modified after a specific date
https://api.constructiononline.com/api/Opportunities?fromDate={date}
This endpoint returns all opportunities that were recently modified, using the entered date and current date to create a specific date range. All opportunities that were modified on or beyond the entered date will be returned. An opportunity's modification date is stored in the property 'LMOD'.
Requests
REQUIRED PARAMETERS
fromDate: date
- Oldest modification date. All opportunities modified on or after the date will be returned.
- Should be entered in YYYY-MM-DD format. For example: October 14 2023 would be 2023-10-14.
Sample URL request:
- https://api.constructiononline.com/api/Opportunities?fromDate=2023-01-01
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
# {date} with the oldest modification date
curl https://api.constructiononline.com/api/Opportunities?fromDate={date} -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
{date} with the oldest modification date */
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?fromDate={date}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{date} with the oldest modification date
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?fromDate={date}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{date} with the oldest modification date */
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?fromDate={date}");
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": 1312899,
"NAME": "1342 S Ross St - version w/out pool",
"CREATED_BY": 999789,
"CREATOR_NAME": "Alice Conway",
"LMOD": "2023-07-28T19:40:31.11",
"ADDRESS": "1342 S Ross St",
"CITY": "Auburn",
"STATE": "AL",
"ZIP": "36830",
"PROJECT_NUMBER": "",
"LMOD_CON_ID": 999984,
"CURRENCY": 0,
"IS_TEMPLATE": true,
"COUNTRY_SETTING": 1,
"CUSTOM_COLOR": "#f7b9d6",
"COMPANY_ID": 24111,
"COMPANY_NAME": "",
"IS_INACTIVE": false,
"ADDR_LAT": 0.000000,
"LAT": 0.000000,
"ADDR_LON": 0.000000,
"LON": 0.000000,
"SCOPE_OF_WORK": "",
"TOTAL_TIME": 0,
"TOTAL_MONEY": 0.0,
"PROJECT_NOTES": "",
"NUMBERFOLDERS": 4,
"NUMBERIMAGES": 1,
"NUMBERALBUMS": 1,
"NUMBERFILES": 2,
"DATE_CREATED": "2022-08-03T15:29:38.19",
"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": 2809,
"OPPORTUNITY_SOURCE": 2875,
"OPPORTUNITY_TYPE": 3820,
"OPPORTUNITY_REFERRER": "",
"OPPORTUNITY_PROBABILITY": 75,
"OPPORTUNITY_VALUE": 800000.0,
"OPPORTUNITY_OPENED_DATE": "2022-08-03T00:00:00",
"OPPORTUNITY_CLOSED_DATE": "2023-09-28T00: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. The date may have been entered in a non-acceptable format, or no opportunities were modified during the specified date range.
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