Skip to content
SIBISIBI Developers
Esc
↑↓navigate↵open⌘Jpreview

Get asset

One asset by its id, in the same shape as an item of the listing: its product identity, install address, dimensions, and warranty coverage windows. The id is accepted as this API serves it (as_-prefixed) or without the prefix. Responds 404 when no asset with that id exists, or when the caller is not authorized to view it.

GET/{id}
Authorization
AuthorizationBearer token · headerrequired

A Sibi Public API token or access token, sent as Authorization: Bearer <token>.

Scopes:read:assets
Path parameters
idstringrequired
min length 1
Responses
200

The 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.

externalIdstring | null

Caller-defined identifier for this asset, unique within its property. Null when the asset was never given one.

externalMetadataobject | null

Key/value data attached to this asset by an integration, at most 8 KiB (8192 bytes) when serialized as UTF-8 JSON. Null when the asset has none.

installedAtstring | null

When the asset was installed, as an ISO 8601 timestamp in UTC. Null when unknown.

categorystringrequired

Broad product category.

subcategoriesstring[]required

Specific subcategories the product belongs to. May be empty.

returnedbooleanrequired

True if this asset has been returned.

poNumberstring | nullrequired

External purchase order number provided with the invoice. Null when the asset has no associated order, or when the caller does not have access to that order.

orderIdstring | nullrequired

Identifier for the order associated with this asset within Sibi. Null when the asset has no associated order, or when the caller does not have access to that order.

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).

400

Invalid input parameters (VALIDATION_ERROR)

codestringrequired
Allowed:VALIDATION_ERROR
messagestringrequired
detailsobject[]required

Per-field validation errors

Show properties
Array of object
fieldstringrequired
errorstringrequired
requestIdstring

Request id for this call — quote it when contacting support

401

The Authorization header is missing, or the bearer token could not be resolved (invalid, expired, or revoked)

codestringrequired

Machine-readable error code

Allowed:UNAUTHORIZED
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

403

The token is missing the scope this operation requires (INSUFFICIENT_SCOPE), is a GraphQL token rather than a REST API token (REST_TOKEN_REQUIRED), or it was minted for the other environment (TOKEN_ENVIRONMENT_MISMATCH)

codestringrequired

Machine-readable error code

Allowed:INSUFFICIENT_SCOPEREST_TOKEN_REQUIREDTOKEN_ENVIRONMENT_MISMATCH
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

404

No asset with this id exists, or the caller is not authorized to view it — the two are deliberately indistinguishable

codestringrequired

Machine-readable error code

Allowed:ASSET_NOT_FOUND
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

500

Internal server error

codestringrequired

Machine-readable error code

Allowed:INTERNAL_SERVER_ERROR
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

503

The token-exchange service is unavailable or misconfigured — retry shortly. Not a token problem.

codestringrequired

Machine-readable error code

Allowed:AUTH_UNAVAILABLE
messagestringrequired
requestIdstring

Request id for this call — quote it when contacting support

Request
curl -X GET "https://api.sibipro.com/assets/as_aBcD1234" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "id": "as_aBcD1234",
  "createdAt": "string",
  "manufacturer": "string",
  "viewUrl": "string",
  "name": "string",
  "sku": "string",
  "serialNumber": "string",
  "externalId": "hvac-unit-7",
  "externalMetadata": {
    "costCenter": "CC-114"
  },
  "installedAt": "2020-06-15T14:30:00.000Z",
  "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."
    }
  ]
}