List assets
curl --request GET \
--url https://api.useopenwrench.com/api/external/v1/buyer/asset/assets \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/asset/assets"
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/asset/assets', 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/asset/assets",
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/asset/assets"
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/asset/assets")
.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/asset/assets")
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": [
{
"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"
}
],
"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>"
}Assets
List assets
Lists assets for the caller’s buyer company, scoped by tenant-security and buyer role-based filters. Filtering: every query parameter other than the pagination parameters is passed to the entity’s filter layer and matched against its indexed columns (multi-value filters are comma-separated strings); the per-entity column names are not exhaustively documented here. Filters are combined with the tenant-security filters derived from the API key.
GET
/
v1
/
buyer
/
asset
/
assets
List assets
curl --request GET \
--url https://api.useopenwrench.com/api/external/v1/buyer/asset/assets \
--header 'OW-KEY: <api-key>' \
--header 'X-API-KEY: <api-key>'import requests
url = "https://api.useopenwrench.com/api/external/v1/buyer/asset/assets"
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/asset/assets', 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/asset/assets",
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/asset/assets"
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/asset/assets")
.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/asset/assets")
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": [
{
"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"
}
],
"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