Playground

Playground

PhysicalAsset

/api/v1/physical-assets

A tracked physical asset (laptop, monitor, IoT device).

listgetcreateupdatedelete

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
asset_tagstringEnterprise inventory asset tag — the physical or logical label affixed to or associated with the device by IT.
namestringHuman-readable name or hostname for the device.
serial_numberstringManufacturer serial number of the device. Used for warranty lookups and insurance claims.
modelstringManufacturer model name or product line.
manufacturerstringName of the device manufacturer.
typestringHardware category of this physical asset.
statusstringCurrent operational status. 'lost_stolen' assets should trigger immediate security review of associated accounts.
assigned_tojsonCurrent assignment details for this device.
purchase_datedate-timeDate on which this device was purchased by the enterprise.
purchase_costjsonOriginal purchase cost of this device.
warranty_expirydate-timeDate on which the manufacturer or extended warranty expires.
osjsonOperating system installed on this device.
managed_bystringName of the MDM or endpoint management tool currently managing this device (e.g. 'Jamf Pro', 'Microsoft Intune', 'CrowdStrike Falcon').
last_seen_atdate-timeISO 8601 timestamp of the last check-in or heartbeat received from this device by the MDM system. Set by the platform during sync.

API

client.assets.*
Loading manifest…