---
title: "Get all assets"
method: GET
path: "/assets"
tags: ["assets"]
---

# Get all assets

`GET /assets`

## Request

- Base URL: `https://api.relynk.io/v2.0.0`
- URL: `https://api.relynk.io/v2.0.0/assets`
- Auth: one of:
  - HTTP bearer
  - API key in header `Authorization`

Get all assets, these are the physical assets in the customer's environment like air handling units, chillers, radiators, dampers, etc.

## Query parameters

- `customerId` string, uuid, required
- `limit` integer
- `offset` integer
- `order` 'asc' | 'desc'
- `sort` 'id' | 'name'
- `name` string
- `name__contains` string
- `id` string, uuid
- `type` string
- `subtype` string
- `path__contains` string
- `includedByCollectionName` string
- `includedByCollectionName__contains` string
- `includeOptionalFields` string[]

## Response `200`

OK

- Asset[]
  - `customerId` string, uuid, required: customer id
  - `id` string, uuid, required: asset id
  - `name` string, required: asset name
  - `description` string, nullable: asset description
  - `subtype` string, required: asset subtype using brickschema/real estate core standard full uri.
  - `type` string, required: asset subtype category using brickschema/real estate core standard full uri.
  - `path` string, required: path to the asset using space and asset ids . seperated
  - `mountedOn` string, uuid, nullable: asset mounted on
  - `operationalStageCount` string, nullable: operational stage count
  - `assetTag` string, nullable: asset tag
  - `commissioningDate` string, date-time, nullable: commissioning date
  - `identifiers` object, nullable: asset identifiers
  - `initialCost` string, nullable
  - `installationDate` string, date-time, nullable
  - `ipAddress` string, nullable: ip address
  - `macAddress` string, nullable: mac address
  - `maintenanceInterval` string, nullable: maintenance interval
  - `modelNumber` string, nullable: model number
  - `serialNumber` string, nullable: serial number
  - `turnoverDate` string, date-time, nullable: turnover date
  - `weight` string, nullable: weight
  - `isVirtualMeter` boolean, nullable: is virtual meter
  - `meterType` string, nullable: meter type
  - `meteringMethod` string, nullable: metering method, cummulative or instantaneous
  - `meterSourceType` string, nullable: meter source type, i.e. solar, grid, etc.
  - `meterUsageType` string, nullable: meter usage type, i.e. heating, fan, lighting, etc.
  - `meteringDerivedFromPointId` string, uuid, nullable: metering derived from point id
  - `locatedInSpaces` string[], nullable: spaces the asset is located in
  - `hasAssetParts` string[], nullable: parts of the asset
  - `isPartOfAssets` string[], nullable: assets the asset is part of
  - `hasPointIntegrationDataSources` string[]: point integration data sources
  - `hasPointIds` string[], nullable: point ids that measure the asset
  - `feedsAssets` string[], nullable: assets the asset feeds
  - `feedsSpaces` string[], nullable: spaces the asset feeds
  - `fedByAssets` string[], nullable: assets that feed the asset
  - `ownedByAgents` string[], nullable: agents that own the asset
  - `includedByCollections` string[], nullable: collections the asset is included in
  - `isSubMeterOfAssets` string[], nullable: assets the asset is a sub meter of
  - `isMeterOfAssets` string[], nullable: assets the asset is a meter of
  - `metersAssets` string[], nullable: assets the asset is metereing
  - `meteredByAssets` string[], nullable: assets the asset is metered by
  - `metersSpaces` string[], nullable: spaces the asset is metering
  - `metersAgents` string[], nullable: agents the asset is metering
  - `metersCollections` string[], nullable: collections the asset is metering

---

[API](https://skmtc.dev/relynk/apis/relynk-api.md) - [All operations](https://skmtc.dev/relynk/apis/relynk-api/llms.txt) - [OpenAPI document](https://skmtc.dev/relynk/apis/relynk-api/revisions/735d9d0efe06?raw)