List assets

A page of the assets the caller can see, each carrying its product identity, install address, dimensions, and warranty coverage windows. With no address this browses every property the caller can see — expect it to be slow; it is meant for one-off backfills, not realtime use. Supply address to narrow to the assets installed at one property. Page by passing the previous response’s next back as after; next is null once a page comes back short.

GET/assets

Query parameters

firstinteger

max 100 · default: 10

afterstring

addressstring

Responses

200Assets the caller is authorized to view

itemsAsset[]required

Show properties

Array of Asset

idstringrequired

Sibi assigned identifier for this asset.

createdAtstringrequired

When the asset was created.

manufacturerstringrequired

A slug identifying which shop the product was purchased from.

viewUrlstringrequired

Link to view the asset in Sibi's web interface.

namestringrequired

Human-readable product name.

skustringrequired

Manufacturer's product identifier.

serialNumberstring | null

Defined by the manufacturer and sometimes provided at invoice time; absent when not reported.

categorystringrequired

Broad product category.

subcategoriesstring[]required

Specific subcategories the product belongs to. May be empty.

returnedbooleanrequired

True if this asset has been returned.

poNumberstring | null

External purchase order number provided with the invoice.

orderIdstring | null

Identifier for the order associated with this asset within Sibi.

propertyAddressAssetPropertyAddressrequired

The address of the property this asset is installed at.

Show properties

line1stringrequired

line2string | null

citystringrequired

stateOrProvincestringrequired

postalCodestringrequired

propertyAssetPropertyrequired

Show properties

externalIdstring | null

Caller-defined identifier for the property.

dimensionsAssetDimensionsrequired

Product measurements. Omits dimensions the product does not report.

Show properties

heightnumber | null

heightUnitstring | null

widthnumber | null

widthUnitstring | null

depthnumber | null

depthUnitstring | null

lengthnumber | null

lengthUnitstring | null

warrantyCoveragesWarrantyCoverage[]required

Time-sliced parts/labor coverage windows for this asset.

Show properties

Array of WarrantyCoverage

startDatestringrequired

endDatestringrequired

descriptionstring | nullrequired

Narrative description of the asset's warranty coverage. Null when no rule applies (e.g. no description rule exists yet for this manufacturer, distinct from having no duration rule at all).

nextstring | nullrequired

Opaque cursor for the next page; pass it as `after`. Null when the page came back short, i.e. there is probably nothing behind it.

400Invalid input parameters (VALIDATION_ERROR), or `after` is not a cursor this endpoint issued (INVALID_CURSOR)

Any of:

ValidationErrorResponse

codestringrequired

Allowed:VALIDATION_ERROR

messagestringrequired

detailsobject[]required

Per-field validation errors

Show properties

Array of object

fieldstringrequired

errorstringrequired

requestIdstring

AWS request id for this call — quote it when contacting support

object

codestringrequired

Machine-readable error code

Allowed:INVALID_CURSOR

messagestringrequired

requestIdstring

AWS request id for this call — quote it when contacting support

401Missing or invalid authentication token

codestringrequired

Machine-readable error code

Allowed:UNAUTHORIZED

messagestringrequired

requestIdstring

AWS request id for this call — quote it when contacting support

500Internal server error

codestringrequired

Machine-readable error code

Allowed:INTERNAL_SERVER_ERROR

messagestringrequired

requestIdstring

AWS request id for this call — quote it when contacting support

Request

curl -X GET "https://api.sibipro.com/assets"

const response = await fetch("https://api.sibipro.com/assets", {
  method: "GET"
});

Response

{
  "items": [
    {
      "id": "as_aBcD1234",
      "createdAt": "string",
      "manufacturer": "string",
      "viewUrl": "string",
      "name": "string",
      "sku": "string",
      "serialNumber": "string",
      "category": "string",
      "subcategories": [
        "string"
      ],
      "returned": true,
      "poNumber": "string",
      "orderId": "string",
      "propertyAddress": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "stateOrProvince": "string",
        "postalCode": "string"
      },
      "property": {
        "externalId": "string"
      },
      "dimensions": {
        "height": 0,
        "heightUnit": "string",
        "width": 0,
        "widthUnit": "string",
        "depth": 0,
        "depthUnit": "string",
        "length": 0,
        "lengthUnit": "string"
      },
      "warrantyCoverages": [
        {
          "startDate": "string",
          "endDate": "string",
          "description": "One-year GE manufacturer warranty covering parts and labor for defects in materials or workmanship."
        }
      ]
    }
  ],
  "next": "string"
}