Get a walkthrough
curl --request GET \
--url https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id} \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}"
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>', 'OW-KEY': '<api-key>'}};
fetch('https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"title": "<string>",
"status": "<string>",
"locationId": 123,
"siteSurveyId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"description": "<string>",
"location": {
"name": "<string>",
"isActive": true,
"locationTypeId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"storeId": "<string>",
"brandId": 123,
"brandAssetGroupId": 123,
"allAssetCount": 123,
"description": "<string>",
"openDate": "2023-11-07T05:31:56Z",
"closeDate": "2023-11-07T05:31:56Z",
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"phoneNumber": "<string>",
"locationTypeDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"notes": "<string>",
"notesNonFormatted": "<string>",
"internalNotes": "<string>",
"images": [
"<string>"
],
"internalAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"primaryContactsEmails": [
"<string>"
],
"facilityInChargeEmails": [
"<string>"
],
"sendApprovedInvoicesToEmails": [
"<string>"
],
"sendApprovedQuotesToEmails": [
"<string>"
],
"storeAssociateEmails": [
"<string>"
],
"fieldTechEmails": [
"<string>"
],
"timeZoneId": "<string>",
"hasPresetAssetUUID": true,
"regionId": 123,
"region": {
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true,
"isDeleted": true,
"id": 123,
"hierarchyName": "<string>",
"parentId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"purchaseOrderPrefix": "<string>",
"isLeased": true,
"leaseStartDate": "2023-11-07T05:31:56Z",
"leaseEndDate": "2023-11-07T05:31:56Z",
"taxRate": "<string>",
"customFieldDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"buildingWarrantyStartDate": "2023-11-07T05:31:56Z",
"buildingWarrantyExpirationDate": "2023-11-07T05:31:56Z",
"buildingWarrantyProblemTypeIds": [
123
],
"buildingWarrantyServiceProviderId": 123,
"invoicesBillTo": {
"billTo": "<string>",
"serviceAddress": {}
},
"countryCode": "<string>",
"totalWOCount": 123,
"totalNotClosedWOCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"projectId": 123,
"taskAnswers": [
{}
],
"scores": [
{
"walkthroughName": "<string>",
"locationName": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"groupTitle": "<string>",
"totalQuestionsCount": 123,
"questionsAnsweredCount": 123,
"score": 123,
"medianScore": "<string>",
"averageScore": "<string>",
"minPossibleScore": 123,
"maxPossibleScore": 123,
"percentageScoreByMaxPossibleScore": "<string>",
"percentageScore": "<string>"
}
],
"notes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "text",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"invitedByName": "<string>",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"invitedByName": "<string>",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"invitedByName": "<string>",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"usersActiveInChat": [
"<string>"
],
"s3EmailReference": "<string>",
"s3EmailReferenceUrl": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"captionGenerationAttempted": true,
"isNoteAwaitingResponse": true,
"isAudioTranslated": true,
"isAudioTranscriptionError": true,
"siteSurveyTaskTitleId": "<string>",
"id": 123
}
],
"fileAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"scheduledBy": "<string>",
"dueAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"completedBy": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"supplierFacilityId": 123,
"buyerSubscriberEmails": [
"<string>"
],
"supplierSubscriberEmails": [
"<string>"
],
"lastNote": "<string>",
"lastNoteType": "<string>",
"lastNoteAddedBy": "<string>",
"lastNoteAddedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"pdfLink": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Site Survey Walkthroughs
Get a walkthrough
Retrieves a single walkthrough by id. Linked work orders in task answers are permission-filtered for the caller.
GET
/
v1
/
buyer
/
site_survey
/
walkthroughs
/
{id}
Get a walkthrough
curl --request GET \
--url https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id} \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}"
headers = {
"X-API-KEY": "<api-key>",
"OW-KEY": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'X-API-KEY': '<api-key>', 'OW-KEY': '<api-key>'}};
fetch('https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"OW-KEY: <api-key>",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("OW-KEY", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}")
.header("X-API-KEY", "<api-key>")
.header("OW-KEY", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.useopenwrench.com/api/external/v1/buyer/site_survey/walkthroughs/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-API-KEY"] = '<api-key>'
request["OW-KEY"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"type": "<string>",
"data": {
"title": "<string>",
"status": "<string>",
"locationId": 123,
"siteSurveyId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"description": "<string>",
"location": {
"name": "<string>",
"isActive": true,
"locationTypeId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"storeId": "<string>",
"brandId": 123,
"brandAssetGroupId": 123,
"allAssetCount": 123,
"description": "<string>",
"openDate": "2023-11-07T05:31:56Z",
"closeDate": "2023-11-07T05:31:56Z",
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"phoneNumber": "<string>",
"locationTypeDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"notes": "<string>",
"notesNonFormatted": "<string>",
"internalNotes": "<string>",
"images": [
"<string>"
],
"internalAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"primaryContactsEmails": [
"<string>"
],
"facilityInChargeEmails": [
"<string>"
],
"sendApprovedInvoicesToEmails": [
"<string>"
],
"sendApprovedQuotesToEmails": [
"<string>"
],
"storeAssociateEmails": [
"<string>"
],
"fieldTechEmails": [
"<string>"
],
"timeZoneId": "<string>",
"hasPresetAssetUUID": true,
"regionId": 123,
"region": {
"name": "<string>",
"buyerCompanyId": 123,
"hasChildren": true,
"isDeleted": true,
"id": 123,
"hierarchyName": "<string>",
"parentId": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"purchaseOrderPrefix": "<string>",
"isLeased": true,
"leaseStartDate": "2023-11-07T05:31:56Z",
"leaseEndDate": "2023-11-07T05:31:56Z",
"taxRate": "<string>",
"customFieldDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<string>"
}
],
"buildingWarrantyStartDate": "2023-11-07T05:31:56Z",
"buildingWarrantyExpirationDate": "2023-11-07T05:31:56Z",
"buildingWarrantyProblemTypeIds": [
123
],
"buildingWarrantyServiceProviderId": 123,
"invoicesBillTo": {
"billTo": "<string>",
"serviceAddress": {}
},
"countryCode": "<string>",
"totalWOCount": 123,
"totalNotClosedWOCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"projectId": 123,
"taskAnswers": [
{}
],
"scores": [
{
"walkthroughName": "<string>",
"locationName": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"groupTitle": "<string>",
"totalQuestionsCount": 123,
"questionsAnsweredCount": 123,
"score": 123,
"medianScore": "<string>",
"averageScore": "<string>",
"minPossibleScore": 123,
"maxPossibleScore": 123,
"percentageScoreByMaxPossibleScore": "<string>",
"percentageScore": "<string>"
}
],
"notes": [
{
"text": "<string>",
"noteAddedBy": "<string>",
"noteAddedAt": "2023-11-07T05:31:56Z",
"photo": "<string>",
"video": "<string>",
"audio": "<string>",
"otherFile": "<string>",
"elements": [
{
"type": "text",
"value": "<string>",
"userObject": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"invitedByName": "<string>",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteReadDetails": [
{
"readAt": "2023-11-07T05:31:56Z",
"readBy": "<string>",
"readByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"invitedByName": "<string>",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}
],
"noteAddedByContact": {
"email": "<string>",
"nameGiven": "<string>",
"nameFamily": "<string>",
"contactType": "<string>",
"title": "<string>",
"department": "<string>",
"facilityId": 123,
"isSharedContact": true,
"readOnlyAccess": true,
"invitedByEmail": "<string>",
"invitedAt": "2023-11-07T05:31:56Z",
"invitedByName": "<string>",
"epaCertificationType": "<string>",
"epaCertificationNumber": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"noteType": "<string>",
"noteAddedByType": "<string>",
"usersActiveInChat": [
"<string>"
],
"s3EmailReference": "<string>",
"s3EmailReferenceUrl": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"captionGenerationAttempted": true,
"isNoteAwaitingResponse": true,
"isAudioTranslated": true,
"isAudioTranscriptionError": true,
"siteSurveyTaskTitleId": "<string>",
"id": 123
}
],
"fileAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"scheduledBy": "<string>",
"dueAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"completedBy": "<string>",
"startTime": "2023-11-07T05:31:56Z",
"endTime": "2023-11-07T05:31:56Z",
"supplierFacilityId": 123,
"buyerSubscriberEmails": [
"<string>"
],
"supplierSubscriberEmails": [
"<string>"
],
"lastNote": "<string>",
"lastNoteType": "<string>",
"lastNoteAddedBy": "<string>",
"lastNoteAddedAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"pdfLink": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"status": "ok"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}{
"message": "<string>",
"type": "<string>",
"status": "error",
"traceId": "<string>"
}Authorizations
OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.
Path Parameters
Response
Success.
Entity type marker, e.g. "Walkthrough".
Site survey walkthrough (read-only on this API). Abridged: hydrated site survey, project, subscriber contact objects may also appear. The embedded siteSurvey carries walkthroughHeatMapRanges (array of {color, lowerRange} color bands for rendering walkthrough scores); a survey with no ranges of its own is returned with its template's ranges already filled in.
Show child attributes
Show child attributes
Available options:
ok