Assets Guide

Look up the assets installed at a property, their warranty coverage, and export them in bulk

The Assets API returns the assets Sibi has on record for a property: what the product is, where it’s installed, its dimensions, and its warranty coverage.

Benefits

• Product identity: SKU, manufacturer, category, and serial number for each installed asset
• Warranty visibility: Time-sliced coverage windows so you can tell what’s covered and when
• Address-scoped: Narrow results to the assets installed at one property
• Single reads: Fetch one asset by its id once you hold it
• Bulk export: Request a file of all your assets, then download it

Core Concepts

Asset ids

Every asset id this API returns carries the as_ prefix, so an id is self-describing wherever it is logged or stored. GET /assets/{id} accepts the id either way: as returned here (as_aBcD1234) or bare (aBcD1234), which is the form GraphQL responses and version 1 asset events carry.

Pagination

Results are paged with an opaque cursor. Pass the previous response’s next back as after to fetch the next page; next is null once a page comes back short.

Exports

An export writes all your assets into one file, so you can load your whole portfolio without paging through GET /assets. It includes the assets in every office the token’s user can access. Exports run in the background: you create one, poll it until it is ready, then download the file.

Create the export

curl \
  --request POST \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  https://api.sibipro.com/assets/exports

const response = await fetch('https://api.sibipro.com/assets/exports', {
  method: 'POST',
  headers: { Authorization: `Bearer ${yourApiKey}` },
});
const exportJob = await response.json();

A successful call returns 202 Accepted with the export in in_progress status and a Location header pointing at it:

{
  "id": "ae_aBcD1234",
  "status": "in_progress",
  "createdAt": "2026-09-24T18:00:00.000Z"
}

Poll for the result

curl \
  --header 'Authorization: Bearer <YOUR_API_KEY>' \
  https://api.sibipro.com/assets/exports/ae_aBcD1234

An export stays in_progress until it moves to succeeded or failed. Poll every few seconds; a large portfolio can take several minutes. Once it has succeeded, the response carries the file’s row count, size, and a download link:

{
  "id": "ae_aBcD1234",
  "status": "succeeded",
  "createdAt": "2026-09-24T18:00:00.000Z",
  "startedAt": "2026-09-24T18:00:02.000Z",
  "completedAt": "2026-09-24T18:03:40.000Z",
  "rowCount": 48210,
  "fileSize": 6291456,
  "download": {
    "url": "https://…",
    "method": "GET",
    "expiresAt": "2026-09-24T18:19:12.000Z"
  }
}

A failed export carries an error with a code and message instead. A failed export could not be generated; create a new export to try again.

Download the file

download.url is a signed link to the file. The link is valid for 15 minutes from the time you read the export; read the export again to get a fresh one.

curl --output assets.jsonl.gz '<download.url>'
gunzip assets.jsonl.gz

The file is gzipped JSON Lines: one asset per line, in exactly the shape GET /assets/{id} returns, so a single parser handles both.

The file is a snapshot of your assets as of the export’s createdAt. A succeeded export keeps its download link, so you can fetch the file again later; create a new export when you want current data.

Test environment

Send requests to https://dev.sibi.pro/assets with a test REST API token to work with test assets. Test assets are kept apart from your real assets: a test request reads, browses, and exports only test assets, and a production request never sees them. An export created in one environment returns 404 in the other.

See Test REST Environment for how the test environment works.

Authentication

Every Assets endpoint requires a Public REST API token. Create the token in the developer dashboard, grant it the scopes below, then send it as Authorization: Bearer <token>.

A request with a token that lacks the scope receives a 403 with code INSUFFICIENT_SCOPE; a token issued for the GraphQL API receives a 403 with code REST_TOKEN_REQUIRED.

Next Steps

Endpoints