https://api.constructiononline.com/api/WarrantyAppointments/{id}
This endpoint enables users to retrieve a record of a warranty appointment from their ConstructionOnline company account.
Requests
REQUIRED PARAMETERS
id: integer
-
Unique Identifier for the warranty appointment.
Sample URL request:
- https://api.constructiononline.com/api/WarrantyAppointments/{id}
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 appointment's ID
curl https://api.constructiononline.com/api/WarrantyAppointments/{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 appointment'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/WarrantyAppointments/{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 appointment'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/WarrantyAppointments/{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 appointment'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/WarrantyAppointments/{id}");
Responses
200: Success
A successful request will return a 200 response with the requested warranty appointment in the body, as seen below.
{
"ID": 9,
"PROJECT_ID": 1432504,
"COMPANY_ID": 23573,
"CREATED_BY": 885048,
"DATE_CREATED": "2025-02-20T15:58:51.51",
"LMOD": "2026-06-17T19:28:54.227",
"LMOD_BY": 885048,
"COMPLETED": true,
"TRAFFIC_COLOR": 0,
"NUMBER": "",
"PARENT_ISSUE_ID": 32,
"NAME": "",
"ARRIVAL_WINDOW_START": "2025-02-28T16:00:00",
"ARRIVAL_WINDOW_END": "2025-02-28T17:00:00",
"NOTES": "Coming to fix HVAC Unit.",
"WORK_STATUS": 120741,
"ADDRESS": "800 W Peachtree St NW,",
"CITY": "Atlanta",
"STATE": "GA",
"ZIP": "30308",
"COUNTRY": 1,
"HAS_RESOURCES": false,
"HAS_CLIENTS": true,
"HAS_TEAMS": false,
"CONFIRMED": false,
"CONFIRMATION_HAS_BEEN_SENT_CLIENT": false,
"CONFIRMATION_HAS_BEEN_SENT_TEAM": false,
"SERVICE_PROVIDER_NOTES": null,
"ATTACHMENTS": null,
"CLIENT_USERS": "[{\"ID\":1355,\"CONTACT_ID\":906920,\"COMPANY_ID\":23573,\"CONFIRMATION_STATUS\":2,\"CANCEL_REASON\":\"\",\"DISPLAY_NAME\":\"Pam Beesly\",\"FIRSTNAME\":\"Pam\",\"LASTNAME\":\"Beesly\",\"EMAIL\":\"clientlinkchill@gmail.com\",\"COMPANY\":\"\"}]",
"TEAM_USERS": null,
"ASSIGNED_RESOURCES": null,
"ISSUE_NAME": "HVAC Unit Leaking"
}
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