API ReferenceAssets

Create Asset

Create a new asset. Requires accountId, siteId, type, manufacturer, model, and serialNumber.

Authentication

x-api-keystring
API Key authentication via header

Request

This endpoint expects an object.
accountIdintegerRequired

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

siteIdintegerRequired
typeenumRequired
Asset type enum.
manufacturerstringRequired
modelstringRequired
serialNumberstringRequired
statusenumOptional
Asset lifecycle status.
Allowed values:
sizedoubleOptional
labelIdslist of integersOptional
Label IDs to attach to the asset.
installDatestringOptionalformat: "date"
manufacturingDatestringOptionalformat: "date"
expectedLifetimedoubleOptional
Expected lifetime in years
descriptionstringOptional
coverImageFileIdintegerOptional
nameplateImageFileIdintegerOptional

Response

Asset created successfully
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