API ReferenceAssets

List Assets

List assets for the authenticated company. Supports pagination and filters (account_id, site_id, status, type, manufacturer, is_archived, date range on updated_at).

Authentication

x-api-keystring
API Key authentication via header

Query parameters

pageintegerOptional>=1Defaults to 1
page_sizeintegerOptional1-100Defaults to 20
order_byenumOptionalDefaults to desc
Allowed values:
account_idintegerOptional
Filter to assets belonging to a specific account.
site_idintegerOptional
statusenumOptional
Asset lifecycle status.
Allowed values:
typeenumOptional
Asset type enum.
manufacturerstringOptional

Case-insensitive substring match on manufacturer.

is_archivedenumOptionalDefaults to false

Filter by archive state. Accepts true / false / 1 / 0.

Allowed values:
updated_afterstringOptionalformat: "date-time"
updated_beforestringOptionalformat: "date-time"

Response

List of assets
idinteger
Asset identifier.
statusenum
Asset lifecycle status.
Allowed values:
siteIdinteger
labelslist of objects
Labels attached to the asset, ordered by position.
isArchivedboolean
uidinteger or null

Short human-readable identifier for the asset (nullable for older records).

namestring or null
typeenum or null
Asset type enum.
manufacturerstring or null
modelstring or null
serialNumberstring or null
accountIdinteger or null

ID of the account (project with type ACCOUNT) the asset belongs to.

sizedouble or null
installDatestring or nullformat: "date"
manufacturingDatestring or nullformat: "date"
expectedLifetimedouble or null
Expected lifetime in years
descriptionstring or null
coverImageFileIdinteger or null
nameplateImageFileIdinteger or null
createdAtstringformat: "date-time"
updatedAtstringformat: "date-time"

Errors

400
Bad Request Error
401
Unauthorized Error