https://api.constructiononline.com/api/Warranties/{id}
This endpoint enables users to retrieve a record of a warranty from their ConstructionOnline company account.
Requests
REQUIRED PARAMETERS
id: integer
-
Unique Identifier for the warranty.
Sample URL request:
- https://api.constructiononline.com/api/Warranties/270
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
# {id} with the warranty's ID
curl https://api.constructiononline.com/api/Warranties/{id} -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
{id} with the warranty's ID */
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/Warranties/{id}"));
Python
#replace {username} with the email address for your ConstructionOnline account
#{password} with your ConstructionOnline password
#{apikey} with your provided API key
#{id} with the warranty's ID
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/Warranties/{id}"))
JavaScript
/* replace {username} with the email address for your ConstructionOnline account
{password} with your ConstructionOnline password
{apikey} with your provided API key
{id} with the warranty's ID */
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/Warranties/{id}");
Responses
200: Success
A successful request will return a 200 response with the requested warranty in the body, as seen below.
{
"ID": 270,
"PROJECT_ID": 1432504,
"COMPANY_ID": 23573,
"CREATED_BY": 885048,
"DATE_CREATED": "2025-05-22T21:47:42.257",
"LMOD_BY": 885048,
"LMOD": "2025-05-22T21:47:42.257",
"NAME": "HVAC Coverage",
"NUMBER": "",
"DESCRIPTION": "",
"NOTES": "",
"WARRANTY_TYPE": 120718,
"START_TIME": "2025-03-01T00:00:00",
"END_TIME": null,
"IS_DRAFT": false,
"PROVIDER": "",
"POLICY_NUMBER": "",
"AGENCY": "",
"AGENCY_CONTACT_ID": 0,
"PRICE_FREQUENCY": 0,
"COST": 0.0,
"PRICE": 0.0,
"SERVICE_FEE": 0.0,
"EXPENSES_TO_DATE": 0.0,
"COVERAGE_LIMIT": 0.0,
"MODEL_NUMBER": "",
"SERIAL_NUMBER": "",
"ATTACHMENTS": null,
"TAGS": null,
"COVERAGE_TYPES": "161",
"END_DATE": "2030-03-01T00:00:00"
}
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: Aug 26, 2026