List work orders
curl --request GET \
--url https://api.useopenwrench.com/api/external/v1/buyer/work_order/work_orders \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/work_order/work_orders"
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/work_order/work_orders', 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/work_order/work_orders",
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/work_order/work_orders"
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/work_order/work_orders")
.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/work_order/work_orders")
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>",
"displayStatus": "<string>",
"status": "<string>",
"locationId": 123,
"problemTypeId": 123,
"currencyId": "<string>",
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"createdBy": "<string>",
"isDeleted": true,
"id": 123,
"buyerSpecificId": "<string>",
"woNumber": "<string>",
"poNumber": "<string>",
"buyerProjectIds": [
123
],
"isPM": true,
"isCapex": true,
"isStale": true,
"isSupplierInitiated": true,
"isCustomerInitiated": true,
"isWarranty": true,
"statusChangedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"descriptionNonFormatted": "<string>",
"assetId": 123,
"asset": {
"isUserAssignedUUID": true,
"name": "<string>",
"assetTypeId": 123,
"locationId": 123,
"isActive": true,
"isLeased": true,
"isRefrigerantTracked": true,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"buyerSpecificAssetId": "<string>",
"assetUUID": "<string>",
"assetNumber": "<string>",
"description": "<string>",
"images": [
"<string>"
],
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"manufacturer": "<string>",
"upcNumber": "<string>",
"modelNumber": "<string>",
"serialNumber": "<string>",
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>"
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"assetModelId": 123,
"assetModel": {
"modelName": "<string>",
"assetTypeId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"manuals": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"specs": [
{
"key": "<string>",
"value": "<string>"
}
],
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>"
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"assetTypeDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<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"
},
"areaId": 123,
"brand": "<string>",
"installDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"leaseStartDate": "2023-11-07T05:31:56Z",
"leaseEndDate": "2023-11-07T05:31:56Z",
"warrantyIds": [
123
],
"lifeExpectancyInMonths": 123,
"originalPrice": 123,
"capitalisedCost": 123,
"assetTags": [
"<string>"
],
"parentId": 123,
"availabilityStatus": "<string>",
"downtimeStatus": "online",
"additionalAssetDetails": {
"energyEfficiencyDetails": "<string>",
"capacityDetails": "<string>",
"hasLeakDetector": true,
"usesRefrigerant": true,
"refrigerantDetails": "<string>"
},
"daysInUse": 123,
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"applianceCategory": "<string>",
"subAssetCount": 123,
"totalWOCount": 123,
"totalNotClosedWOCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"subAssetIds": [
123
],
"isAssetDown": true,
"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"
},
"areaId": 123,
"workCategoryId": 123,
"spendCategoryId": 123,
"problemType": {
"id": 123,
"name": "<string>"
},
"woPriorityId": 123,
"approvedOrDeniedAt": "2023-11-07T05:31:56Z",
"approvedOrDeniedBy": "<string>",
"needsApproval": true,
"requiresSignature": true,
"images": [
"<string>"
],
"dueDate": "2023-11-07T05:31:56Z",
"staleAt": "2023-11-07T05:31:56Z",
"scheduledAt": "2023-11-07T05:31:56Z",
"estimatedCompletionDate": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"markedCompleteBy": "<string>",
"expirationAt": "2023-11-07T05:31:56Z",
"assignedAt": "2023-11-07T05:31:56Z",
"supplierRespondedAt": "2023-11-07T05:31:56Z",
"supplierFacilityId": 123,
"supplierFacility": {
"name": "<string>",
"displayName": "<string>",
"status": "<string>",
"currencyId": "<string>",
"supplierCompanyId": 123,
"isLandlord": true,
"id": 123,
"isClaimed": true,
"about": "<string>",
"isNationalSupplier": true,
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"w9": {
"fileName": "<string>",
"fileId": "<string>"
},
"verifications": [
{}
],
"licenses": [
{}
],
"certifications": [
{}
],
"insurances": [
{}
],
"faqs": [
{}
],
"isWomenOwned": true,
"isMinorityOwned": true,
"isVeteranOwned": true,
"isDisabledOwned": true,
"isLgbtOwned": true,
"isSmallBusinessEnterprise": true,
"categoryIds": [
123
],
"categoryNames": "<string>",
"duns": "<string>",
"taxId": "<string>",
"corporateURL": "<string>",
"storefrontURL": "<string>",
"logoURL": "<string>",
"poMethod": "<string>",
"poChangeMethod": "<string>",
"poEmail": "<string>",
"website": "<string>",
"primaryContactEmail": "<string>",
"primaryPhone": "<string>",
"primaryAddress": {},
"remitToAddress": {},
"latitude": 123,
"longitude": 123,
"radiusOfServiceInMiles": 123,
"serviceAreaSelfPerforming": [
"<string>"
],
"serviceAreaNotSelfPerforming": [
"<string>"
],
"averageRating": 123,
"numRatings": 123
},
"supplierPrimaryContactEmail": "<string>",
"price": 123,
"terms": "<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
}
],
"lastNote": "<string>",
"lastNoteAddedBy": "<string>",
"lastNoteAddedAt": 123,
"nte": 123,
"statusChanges": [
{
"statusText": "<string>",
"statusChangeAt": "2023-11-07T05:31:56Z"
}
],
"submittedByName": "<string>",
"buyerSubscriberEmails": [
"<string>"
],
"supplierSubscriberEmails": [
"<string>"
],
"associatedServiceCalls": [
{
"supplierFacilityId": 123,
"numberOfTechs": 123,
"workOrderId": 123,
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"leadTechnicianEmail": "<string>",
"leadTechnicianEmailContact": {
"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"
},
"additionalTechnicianEmails": [
"<string>"
],
"additionalTechnicians": [
{
"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"
}
],
"stockLocationIds": [
123
],
"stockLocations": [
{}
],
"supplierFacility": {
"name": "<string>",
"displayName": "<string>",
"status": "<string>",
"currencyId": "<string>",
"supplierCompanyId": 123,
"isLandlord": true,
"id": 123,
"isClaimed": true,
"about": "<string>",
"isNationalSupplier": true,
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"w9": {
"fileName": "<string>",
"fileId": "<string>"
},
"verifications": [
{}
],
"licenses": [
{}
],
"certifications": [
{}
],
"insurances": [
{}
],
"faqs": [
{}
],
"isWomenOwned": true,
"isMinorityOwned": true,
"isVeteranOwned": true,
"isDisabledOwned": true,
"isLgbtOwned": true,
"isSmallBusinessEnterprise": true,
"categoryIds": [
123
],
"categoryNames": "<string>",
"duns": "<string>",
"taxId": "<string>",
"corporateURL": "<string>",
"storefrontURL": "<string>",
"logoURL": "<string>",
"poMethod": "<string>",
"poChangeMethod": "<string>",
"poEmail": "<string>",
"website": "<string>",
"primaryContactEmail": "<string>",
"primaryPhone": "<string>",
"primaryAddress": {},
"remitToAddress": {},
"latitude": 123,
"longitude": 123,
"radiusOfServiceInMiles": 123,
"serviceAreaSelfPerforming": [
"<string>"
],
"serviceAreaNotSelfPerforming": [
"<string>"
],
"averageRating": 123,
"numRatings": 123
},
"serviceScheduledAt": "2023-11-07T05:31:56Z",
"checkInByEmail": "<string>",
"checkInByContact": {
"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"
},
"checkInStatus": "<string>",
"checkInTime": "2023-11-07T05:31:56Z",
"checkInNotes": "<string>",
"checkInImages": [
"<string>"
],
"checkInImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkInGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkInAudio": "<string>",
"checkInAudioTranscription": "<string>",
"checkInIsAudioTranslated": true,
"checkInIsAudioTranscriptionError": true,
"checkOutByEmail": "<string>",
"checkOutByContact": {
"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"
},
"checkOutStatus": "<string>",
"checkOutTime": "2023-11-07T05:31:56Z",
"checkOutNotes": "<string>",
"checkOutImages": [
"<string>"
],
"checkOutImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkOutGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkOutAudio": "<string>",
"checkOutAudioTranscription": "<string>",
"checkOutIsAudioTranslated": true,
"checkOutIsAudioTranscriptionError": true,
"revisionChanges": [
{}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"lastServiceCall": {
"supplierFacilityId": 123,
"numberOfTechs": 123,
"workOrderId": 123,
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"leadTechnicianEmail": "<string>",
"leadTechnicianEmailContact": {
"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"
},
"additionalTechnicianEmails": [
"<string>"
],
"additionalTechnicians": [
{
"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"
}
],
"stockLocationIds": [
123
],
"stockLocations": [
{}
],
"supplierFacility": {
"name": "<string>",
"displayName": "<string>",
"status": "<string>",
"currencyId": "<string>",
"supplierCompanyId": 123,
"isLandlord": true,
"id": 123,
"isClaimed": true,
"about": "<string>",
"isNationalSupplier": true,
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"w9": {
"fileName": "<string>",
"fileId": "<string>"
},
"verifications": [
{}
],
"licenses": [
{}
],
"certifications": [
{}
],
"insurances": [
{}
],
"faqs": [
{}
],
"isWomenOwned": true,
"isMinorityOwned": true,
"isVeteranOwned": true,
"isDisabledOwned": true,
"isLgbtOwned": true,
"isSmallBusinessEnterprise": true,
"categoryIds": [
123
],
"categoryNames": "<string>",
"duns": "<string>",
"taxId": "<string>",
"corporateURL": "<string>",
"storefrontURL": "<string>",
"logoURL": "<string>",
"poMethod": "<string>",
"poChangeMethod": "<string>",
"poEmail": "<string>",
"website": "<string>",
"primaryContactEmail": "<string>",
"primaryPhone": "<string>",
"primaryAddress": {},
"remitToAddress": {},
"latitude": 123,
"longitude": 123,
"radiusOfServiceInMiles": 123,
"serviceAreaSelfPerforming": [
"<string>"
],
"serviceAreaNotSelfPerforming": [
"<string>"
],
"averageRating": 123,
"numRatings": 123
},
"serviceScheduledAt": "2023-11-07T05:31:56Z",
"checkInByEmail": "<string>",
"checkInByContact": {
"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"
},
"checkInStatus": "<string>",
"checkInTime": "2023-11-07T05:31:56Z",
"checkInNotes": "<string>",
"checkInImages": [
"<string>"
],
"checkInImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkInGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkInAudio": "<string>",
"checkInAudioTranscription": "<string>",
"checkInIsAudioTranslated": true,
"checkInIsAudioTranscriptionError": true,
"checkOutByEmail": "<string>",
"checkOutByContact": {
"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"
},
"checkOutStatus": "<string>",
"checkOutTime": "2023-11-07T05:31:56Z",
"checkOutNotes": "<string>",
"checkOutImages": [
"<string>"
],
"checkOutImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkOutGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkOutAudio": "<string>",
"checkOutAudioTranscription": "<string>",
"checkOutIsAudioTranslated": true,
"checkOutIsAudioTranscriptionError": true,
"revisionChanges": [
{}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"hasBuyerArchived": true,
"hasSupplierArchived": true,
"buyerAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"supplierAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"resolutionTypeId": 123,
"plannedMaintenanceScheduleId": 123,
"walkThroughId": 123,
"cancelledAt": "2023-11-07T05:31:56Z",
"cancelledBy": "<string>",
"isPrivate": true,
"fromRequestPortal": true,
"fromClientPortal": true,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"count": 123,
"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>"
}Work Orders
List work orders
Lists work orders for the caller’s buyer company. The page and total are resolved in the search index, then the matching records are loaded from the read replica; a just-created work order can be briefly absent while the index and replica catch up. Filtering: every query parameter other than the pagination parameters is matched against the work order’s indexed search-document fields (multi-value filters are comma-separated strings). assetId/assetIds also match sub-assets. Filters not present in the search document (updatedAtStartDate, updatedAtEndDate, buyerFacilityId, walkthroughId) are ignored. sort_by supports createdAt, locationName, woPriority, and lastServiceCallServiceScheduledAt; any other value falls back to createdAt descending. offset + limit cannot exceed the 10,000-result search window. Filters are combined with the tenant-security filters derived from the API key.
GET
/
v1
/
buyer
/
work_order
/
work_orders
List work orders
curl --request GET \
--url https://api.useopenwrench.com/api/external/v1/buyer/work_order/work_orders \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/work_order/work_orders"
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/work_order/work_orders', 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/work_order/work_orders",
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/work_order/work_orders"
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/work_order/work_orders")
.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/work_order/work_orders")
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>",
"displayStatus": "<string>",
"status": "<string>",
"locationId": 123,
"problemTypeId": 123,
"currencyId": "<string>",
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"createdBy": "<string>",
"isDeleted": true,
"id": 123,
"buyerSpecificId": "<string>",
"woNumber": "<string>",
"poNumber": "<string>",
"buyerProjectIds": [
123
],
"isPM": true,
"isCapex": true,
"isStale": true,
"isSupplierInitiated": true,
"isCustomerInitiated": true,
"isWarranty": true,
"statusChangedAt": "2023-11-07T05:31:56Z",
"description": "<string>",
"descriptionNonFormatted": "<string>",
"assetId": 123,
"asset": {
"isUserAssignedUUID": true,
"name": "<string>",
"assetTypeId": 123,
"locationId": 123,
"isActive": true,
"isLeased": true,
"isRefrigerantTracked": true,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"buyerSpecificAssetId": "<string>",
"assetUUID": "<string>",
"assetNumber": "<string>",
"description": "<string>",
"images": [
"<string>"
],
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"manufacturer": "<string>",
"upcNumber": "<string>",
"modelNumber": "<string>",
"serialNumber": "<string>",
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>"
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"assetModelId": 123,
"assetModel": {
"modelName": "<string>",
"assetTypeId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"manuals": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"specs": [
{
"key": "<string>",
"value": "<string>"
}
],
"assetType": {
"name": "<string>",
"usesRefrigerant": true,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"primarySpendCategory": 123,
"attachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"allProblemTypeIds": [
123
],
"allProblemTypeIdsAsString": "<string>",
"allProblemTypes": [
{
"id": 123,
"name": "<string>"
}
],
"allProblemTypesName": "<string>",
"allSpendCategories": [
123
],
"depreciationClassId": 123,
"depreciationClassName": "<string>",
"requiredFields": [
{}
],
"optionalFields": [
{}
],
"replaceMarkupOnOriginalCost": 123,
"replacementThreshold": 123,
"applianceCategory": "<string>",
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"assetTypeDetails": [
{
"key": "<string>",
"valueAsString": "<string>",
"valueType": "<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"
},
"areaId": 123,
"brand": "<string>",
"installDate": "2023-11-07T05:31:56Z",
"purchaseDate": "2023-11-07T05:31:56Z",
"leaseStartDate": "2023-11-07T05:31:56Z",
"leaseEndDate": "2023-11-07T05:31:56Z",
"warrantyIds": [
123
],
"lifeExpectancyInMonths": 123,
"originalPrice": 123,
"capitalisedCost": 123,
"assetTags": [
"<string>"
],
"parentId": 123,
"availabilityStatus": "<string>",
"downtimeStatus": "online",
"additionalAssetDetails": {
"energyEfficiencyDetails": "<string>",
"capacityDetails": "<string>",
"hasLeakDetector": true,
"usesRefrigerant": true,
"refrigerantDetails": "<string>"
},
"daysInUse": 123,
"refrigerantTypeCode": "<string>",
"fullChargeLb": 123,
"applianceCategory": "<string>",
"subAssetCount": 123,
"totalWOCount": 123,
"totalNotClosedWOCount": 123,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"subAssetIds": [
123
],
"isAssetDown": true,
"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"
},
"areaId": 123,
"workCategoryId": 123,
"spendCategoryId": 123,
"problemType": {
"id": 123,
"name": "<string>"
},
"woPriorityId": 123,
"approvedOrDeniedAt": "2023-11-07T05:31:56Z",
"approvedOrDeniedBy": "<string>",
"needsApproval": true,
"requiresSignature": true,
"images": [
"<string>"
],
"dueDate": "2023-11-07T05:31:56Z",
"staleAt": "2023-11-07T05:31:56Z",
"scheduledAt": "2023-11-07T05:31:56Z",
"estimatedCompletionDate": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"markedCompleteBy": "<string>",
"expirationAt": "2023-11-07T05:31:56Z",
"assignedAt": "2023-11-07T05:31:56Z",
"supplierRespondedAt": "2023-11-07T05:31:56Z",
"supplierFacilityId": 123,
"supplierFacility": {
"name": "<string>",
"displayName": "<string>",
"status": "<string>",
"currencyId": "<string>",
"supplierCompanyId": 123,
"isLandlord": true,
"id": 123,
"isClaimed": true,
"about": "<string>",
"isNationalSupplier": true,
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"w9": {
"fileName": "<string>",
"fileId": "<string>"
},
"verifications": [
{}
],
"licenses": [
{}
],
"certifications": [
{}
],
"insurances": [
{}
],
"faqs": [
{}
],
"isWomenOwned": true,
"isMinorityOwned": true,
"isVeteranOwned": true,
"isDisabledOwned": true,
"isLgbtOwned": true,
"isSmallBusinessEnterprise": true,
"categoryIds": [
123
],
"categoryNames": "<string>",
"duns": "<string>",
"taxId": "<string>",
"corporateURL": "<string>",
"storefrontURL": "<string>",
"logoURL": "<string>",
"poMethod": "<string>",
"poChangeMethod": "<string>",
"poEmail": "<string>",
"website": "<string>",
"primaryContactEmail": "<string>",
"primaryPhone": "<string>",
"primaryAddress": {},
"remitToAddress": {},
"latitude": 123,
"longitude": 123,
"radiusOfServiceInMiles": 123,
"serviceAreaSelfPerforming": [
"<string>"
],
"serviceAreaNotSelfPerforming": [
"<string>"
],
"averageRating": 123,
"numRatings": 123
},
"supplierPrimaryContactEmail": "<string>",
"price": 123,
"terms": "<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
}
],
"lastNote": "<string>",
"lastNoteAddedBy": "<string>",
"lastNoteAddedAt": 123,
"nte": 123,
"statusChanges": [
{
"statusText": "<string>",
"statusChangeAt": "2023-11-07T05:31:56Z"
}
],
"submittedByName": "<string>",
"buyerSubscriberEmails": [
"<string>"
],
"supplierSubscriberEmails": [
"<string>"
],
"associatedServiceCalls": [
{
"supplierFacilityId": 123,
"numberOfTechs": 123,
"workOrderId": 123,
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"leadTechnicianEmail": "<string>",
"leadTechnicianEmailContact": {
"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"
},
"additionalTechnicianEmails": [
"<string>"
],
"additionalTechnicians": [
{
"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"
}
],
"stockLocationIds": [
123
],
"stockLocations": [
{}
],
"supplierFacility": {
"name": "<string>",
"displayName": "<string>",
"status": "<string>",
"currencyId": "<string>",
"supplierCompanyId": 123,
"isLandlord": true,
"id": 123,
"isClaimed": true,
"about": "<string>",
"isNationalSupplier": true,
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"w9": {
"fileName": "<string>",
"fileId": "<string>"
},
"verifications": [
{}
],
"licenses": [
{}
],
"certifications": [
{}
],
"insurances": [
{}
],
"faqs": [
{}
],
"isWomenOwned": true,
"isMinorityOwned": true,
"isVeteranOwned": true,
"isDisabledOwned": true,
"isLgbtOwned": true,
"isSmallBusinessEnterprise": true,
"categoryIds": [
123
],
"categoryNames": "<string>",
"duns": "<string>",
"taxId": "<string>",
"corporateURL": "<string>",
"storefrontURL": "<string>",
"logoURL": "<string>",
"poMethod": "<string>",
"poChangeMethod": "<string>",
"poEmail": "<string>",
"website": "<string>",
"primaryContactEmail": "<string>",
"primaryPhone": "<string>",
"primaryAddress": {},
"remitToAddress": {},
"latitude": 123,
"longitude": 123,
"radiusOfServiceInMiles": 123,
"serviceAreaSelfPerforming": [
"<string>"
],
"serviceAreaNotSelfPerforming": [
"<string>"
],
"averageRating": 123,
"numRatings": 123
},
"serviceScheduledAt": "2023-11-07T05:31:56Z",
"checkInByEmail": "<string>",
"checkInByContact": {
"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"
},
"checkInStatus": "<string>",
"checkInTime": "2023-11-07T05:31:56Z",
"checkInNotes": "<string>",
"checkInImages": [
"<string>"
],
"checkInImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkInGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkInAudio": "<string>",
"checkInAudioTranscription": "<string>",
"checkInIsAudioTranslated": true,
"checkInIsAudioTranscriptionError": true,
"checkOutByEmail": "<string>",
"checkOutByContact": {
"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"
},
"checkOutStatus": "<string>",
"checkOutTime": "2023-11-07T05:31:56Z",
"checkOutNotes": "<string>",
"checkOutImages": [
"<string>"
],
"checkOutImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkOutGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkOutAudio": "<string>",
"checkOutAudioTranscription": "<string>",
"checkOutIsAudioTranslated": true,
"checkOutIsAudioTranscriptionError": true,
"revisionChanges": [
{}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"lastServiceCall": {
"supplierFacilityId": 123,
"numberOfTechs": 123,
"workOrderId": 123,
"locationId": 123,
"buyerFacilityId": 123,
"buyerCompanyId": 123,
"isDeleted": true,
"id": 123,
"leadTechnicianEmail": "<string>",
"leadTechnicianEmailContact": {
"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"
},
"additionalTechnicianEmails": [
"<string>"
],
"additionalTechnicians": [
{
"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"
}
],
"stockLocationIds": [
123
],
"stockLocations": [
{}
],
"supplierFacility": {
"name": "<string>",
"displayName": "<string>",
"status": "<string>",
"currencyId": "<string>",
"supplierCompanyId": 123,
"isLandlord": true,
"id": 123,
"isClaimed": true,
"about": "<string>",
"isNationalSupplier": true,
"operatingHours": {
"timeZoneId": "<string>",
"timeZoneName": "<string>",
"Monday": {},
"Tuesday": {},
"Wednesday": {},
"Thursday": {},
"Friday": {},
"Saturday": {},
"Sunday": {}
},
"w9": {
"fileName": "<string>",
"fileId": "<string>"
},
"verifications": [
{}
],
"licenses": [
{}
],
"certifications": [
{}
],
"insurances": [
{}
],
"faqs": [
{}
],
"isWomenOwned": true,
"isMinorityOwned": true,
"isVeteranOwned": true,
"isDisabledOwned": true,
"isLgbtOwned": true,
"isSmallBusinessEnterprise": true,
"categoryIds": [
123
],
"categoryNames": "<string>",
"duns": "<string>",
"taxId": "<string>",
"corporateURL": "<string>",
"storefrontURL": "<string>",
"logoURL": "<string>",
"poMethod": "<string>",
"poChangeMethod": "<string>",
"poEmail": "<string>",
"website": "<string>",
"primaryContactEmail": "<string>",
"primaryPhone": "<string>",
"primaryAddress": {},
"remitToAddress": {},
"latitude": 123,
"longitude": 123,
"radiusOfServiceInMiles": 123,
"serviceAreaSelfPerforming": [
"<string>"
],
"serviceAreaNotSelfPerforming": [
"<string>"
],
"averageRating": 123,
"numRatings": 123
},
"serviceScheduledAt": "2023-11-07T05:31:56Z",
"checkInByEmail": "<string>",
"checkInByContact": {
"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"
},
"checkInStatus": "<string>",
"checkInTime": "2023-11-07T05:31:56Z",
"checkInNotes": "<string>",
"checkInImages": [
"<string>"
],
"checkInImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkInGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkInAudio": "<string>",
"checkInAudioTranscription": "<string>",
"checkInIsAudioTranslated": true,
"checkInIsAudioTranscriptionError": true,
"checkOutByEmail": "<string>",
"checkOutByContact": {
"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"
},
"checkOutStatus": "<string>",
"checkOutTime": "2023-11-07T05:31:56Z",
"checkOutNotes": "<string>",
"checkOutImages": [
"<string>"
],
"checkOutImagesWithCaption": [
{
"s3ObjectKey": "<string>",
"caption": "<string>",
"captionSource": "<string>",
"captionModel": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"createdBy": "<string>",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"checkOutGeoLocation": {
"lat": "<string>",
"long": "<string>"
},
"checkOutAudio": "<string>",
"checkOutAudioTranscription": "<string>",
"checkOutIsAudioTranslated": true,
"checkOutIsAudioTranscriptionError": true,
"revisionChanges": [
{}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
},
"hasBuyerArchived": true,
"hasSupplierArchived": true,
"buyerAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"supplierAttachments": [
{
"fileName": "<string>",
"fileId": "<string>"
}
],
"resolutionTypeId": 123,
"plannedMaintenanceScheduleId": 123,
"walkThroughId": 123,
"cancelledAt": "2023-11-07T05:31:56Z",
"cancelledBy": "<string>",
"isPrivate": true,
"fromRequestPortal": true,
"fromClientPortal": true,
"glCode": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"deletedAt": "2023-11-07T05:31:56Z"
}
],
"count": 123,
"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>"
}Authorizations
OpenWrench shared secret. Required on every request alongside X-API-KEY; issued together with your API key.
Query Parameters
Number of records to skip.
Required range:
x >= 0Page size. Default 10, maximum 25.
Required range:
1 <= x <= 25Field/column to sort by.
Sort direction.
Available options:
asc, desc Full-text search. Matches words (with prefix and stem matching) across the title, description, location name, notes, service call check-in/check-out notes, problem type name, and reference numbers (work order number, PO number, asset serial number). Wrap the value in double quotes to require the exact phrase.