List Assets | Coperniq API

const url = 'https://api.coperniq.io/v1/assets';
const options = {method: 'GET', headers: {'x-api-key': '<apiKey>'}};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

[
  {
    "id": 1,
    "status": "DRAFT",
    "siteId": 1,
    "labels": [
      {
        "id": 1,
        "name": "string",
        "type": "ASSET",
        "color": "string"
      }
    ],
    "isArchived": true,
    "uid": 1,
    "name": "string",
    "type": "BATTERY_SYSTEM",
    "manufacturer": "string",
    "model": "string",
    "serialNumber": "string",
    "accountId": 1,
    "size": 1.1,
    "installDate": "2023-01-15",
    "manufacturingDate": "2023-01-15",
    "expectedLifetime": 1.1,
    "description": "string",
    "coverImageFileId": 1,
    "nameplateImageFileId": 1,
    "createdAt": "2024-01-15T09:30:00Z",
    "updatedAt": "2024-01-15T09:30:00Z"
  }
]

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.

siteIdinteger

labelslist of objects

Labels attached to the asset, ordered by position.

isArchivedboolean

uidinteger or nullOptional

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

namestring or nullOptional

typeenum or nullOptional

Asset type enum.

manufacturerstring or nullOptional

modelstring or nullOptional

serialNumberstring or nullOptional

accountIdinteger or nullOptional

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

sizedouble or nullOptional

installDatestring or nullOptionalformat: "date"

manufacturingDatestring or nullOptionalformat: "date"

expectedLifetimedouble or nullOptional

Expected lifetime in years

descriptionstring or nullOptional

coverImageFileIdinteger or nullOptional

nameplateImageFileIdinteger or nullOptional

createdAtstringOptionalformat: "date-time"

updatedAtstringOptionalformat: "date-time"

Errors

400

Bad Request Error

401

Unauthorized Error