assets

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

get/assets

Request

  • Base URL: https://api.coperniq.io/v1
  • URL: https://api.coperniq.io/v1/assets
  • Auth: API key in header x-api-key

Query parameters

pageinteger
page_sizeinteger
order_by'asc' | 'desc'
account_idinteger

Filter to assets belonging to a specific account.

site_idinteger
status'DRAFT' | 'ACTIVE' | 'MAINTENANCE' | 'INACTIVE' | 'RETIRED'

Asset lifecycle status.

type'BATTERY_SYSTEM' | 'CHARGING_GATEWAY' | 'COMBINER_BOX' | 'EV_CHARGER' | 'LOAD_CENTER' | 'MICROINVERTER' | 'POWER_OPTIMIZER' | 'PRODUCTION_METER' | 'RAPID_SHUTDOWN_DEVICE' | 'PV_INVERTER' | 'TRACKER' | 'WEATHER_STATION' | 'AIR_CONDITIONER' | 'AIR_HANDLING_UNIT' | 'BOILER' | 'CHILLER' | 'COOLING_TOWER' | 'FAN' | 'HEAT_EXCHANGER' | 'HEAT_PUMP' | 'MAKE_UP_AIR_UNIT' | 'PUMP' | 'ROOFTOP_UNIT' | 'THERMOSTAT' | 'VARIABLE_FREQUENCY_DRIVE' | 'AUTOMATIC_TRANSFER_SWITCH' | 'BREAKER' | 'DISCONNECT_SWITCH' | 'ELECTRIC_METER' | 'GENERATOR' | 'LIGHTING_PANEL' | 'PANELBOARD' | 'SWITCHGEAR' | 'TRANSFORMER' | 'UNINTERRUPTIBLE_POWER_SUPPLY' | 'BACKFLOW_PREVENTER' | 'BOOSTER_PUMP' | 'GREASE_INTERCEPTOR' | 'STORAGE_TANK' | 'SUMP_PUMP' | 'VALVE' | 'WATER_FILTRATION_SYSTEM' | 'WATER_HEATER' | 'WATER_SOFTENER' | 'ACCESS_CONTROLLER' | 'AUTOMATION_CONTROLLER' | 'CAMERA' | 'CARD_READER' | 'DOOR_STRIKE' | 'MAGLOCK' | 'NETWORK_SWITCH' | 'NETWORK_VIDEO_RECORDER' | 'SENSOR' | 'WIRELESS_ACCESS_POINT' | 'OTHER'

Asset type enum.

manufacturerstring

Case-insensitive substring match on manufacturer.

is_archived'true' | 'false' | '1' | '0'

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

updated_afterstring date-time
updated_beforestring date-time

Response

List of assets

idinteger required

Asset identifier.

uidinteger nullable

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

namestring nullable
type'BATTERY_SYSTEM' | 'CHARGING_GATEWAY' | 'COMBINER_BOX' | 'EV_CHARGER' | 'LOAD_CENTER' | 'MICROINVERTER' | 'POWER_OPTIMIZER' | 'PRODUCTION_METER' | 'RAPID_SHUTDOWN_DEVICE' | 'PV_INVERTER' | 'TRACKER' | 'WEATHER_STATION' | 'AIR_CONDITIONER' | 'AIR_HANDLING_UNIT' | 'BOILER' | 'CHILLER' | 'COOLING_TOWER' | 'FAN' | 'HEAT_EXCHANGER' | 'HEAT_PUMP' | 'MAKE_UP_AIR_UNIT' | 'PUMP' | 'ROOFTOP_UNIT' | 'THERMOSTAT' | 'VARIABLE_FREQUENCY_DRIVE' | 'AUTOMATIC_TRANSFER_SWITCH' | 'BREAKER' | 'DISCONNECT_SWITCH' | 'ELECTRIC_METER' | 'GENERATOR' | 'LIGHTING_PANEL' | 'PANELBOARD' | 'SWITCHGEAR' | 'TRANSFORMER' | 'UNINTERRUPTIBLE_POWER_SUPPLY' | 'BACKFLOW_PREVENTER' | 'BOOSTER_PUMP' | 'GREASE_INTERCEPTOR' | 'STORAGE_TANK' | 'SUMP_PUMP' | 'VALVE' | 'WATER_FILTRATION_SYSTEM' | 'WATER_HEATER' | 'WATER_SOFTENER' | 'ACCESS_CONTROLLER' | 'AUTOMATION_CONTROLLER' | 'CAMERA' | 'CARD_READER' | 'DOOR_STRIKE' | 'MAGLOCK' | 'NETWORK_SWITCH' | 'NETWORK_VIDEO_RECORDER' | 'SENSOR' | 'WIRELESS_ACCESS_POINT' | 'OTHER'

Asset type enum.

status'DRAFT' | 'ACTIVE' | 'MAINTENANCE' | 'INACTIVE' | 'RETIRED' required

Asset lifecycle status.

manufacturerstring nullable
modelstring nullable
serialNumberstring nullable
siteIdinteger required
accountIdinteger nullable

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

sizenumber double nullable
installDatestring date nullable
manufacturingDatestring date nullable
expectedLifetimenumber double nullable

Expected lifetime in years

descriptionstring nullable
coverImageFileIdinteger nullable
nameplateImageFileIdinteger nullable
isArchivedboolean required
createdAtstring date-time
updatedAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.