Skip to main content
GET
/
assets
/
{id}
JavaScript SDK
const assets = await client.assets.retrieve([{id: 123}, {externalId: 'abc'}]);
{
  "createdTime": 1730204346000,
  "lastUpdatedTime": 1730204346000,
  "rootId": 4503599627370496,
  "name": "<string>",
  "id": 4503599627370496,
  "aggregates": {
    "childCount": 1,
    "depth": 1,
    "path": [
      {
        "id": 4503599627370496
      }
    ]
  },
  "parentId": 4503599627370496,
  "parentExternalId": "my.known.id",
  "externalId": "my.known.id",
  "description": "<string>",
  "dataSetId": 4503599627370496,
  "metadata": {},
  "source": "<string>",
  "labels": [
    {
      "externalId": "my.known.id"
    }
  ],
  "geoLocation": {
    "geometry": {
      "coordinates": [
        123
      ]
    },
    "properties": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.cognite.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Access token issued by the CDF project's configured identity provider. Access token must be an OpenID Connect token, and the project must be configured to accept OpenID Connect tokens. Use a header key of 'Authorization' with a value of 'Bearer $accesstoken'. The token can be obtained through any flow supported by the identity provider.

Path Parameters

​
id
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991

Response

Response with a single asset.

A representation of a physical asset, for example a factory or a piece of equipment.

​
createdTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
lastUpdatedTime
integer<int64>
required

The number of milliseconds since 00:00:00 Thursday, 1 January 1970, Coordinated Universal Time (UTC), minus leap seconds.

Required range: x >= 0
Example:

1730204346000

​
rootId
integer<int64>
required

The ID of the root asset. The root asset is the asset spanning the entire asset hierarchy that this asset belongs to.

Required range: 1 <= x <= 9007199254740991
​
name
string
required

The name of the asset.

Required string length: 1 - 140
​
id
integer<int64>
required

A server-generated ID for the object.

Required range: 1 <= x <= 9007199254740991
​
aggregates
object

Aggregated metrics of the asset.

​
parentId
integer<int64>

The parent node's ID used to specify parent-child relationship.

You should not use this field in combination with the parentExternalId field.

Required range: 1 <= x <= 9007199254740991
​
parentExternalId
string

The parent node's external ID used to specify the parent-child relationship. When specifying this field, the API will resolve the external ID into an internal ID and use the internal ID to store the parent-child relation. As a result, a later change to update the parent's external ID will not affect this parent-child relationship as it is based on internal ID.

You should not use this field in combination with the parentId field.

Maximum string length: 255
Example:

"my.known.id"

​
externalId
string

The external ID provided by the client. Must be unique for the resource type.

Maximum string length: 255
Example:

"my.known.id"

​
description
string

The description of the asset.

Maximum string length: 500
​
dataSetId
integer<int64>

The id of the dataset this asset belongs to.

Required range: 1 <= x <= 9007199254740991
​
metadata
object

Custom, application specific metadata. String key -> String value. Limits: Maximum length of key is 128 bytes, value 10240 bytes, up to 256 key-value pairs, of total size at most 10240.

​
source
string

The source of the asset.

Maximum string length: 128
​
labels
Label · object[]

A list of the labels associated with this resource item.

Maximum array length: 10
​
geoLocation
object

Geographic metadata.

Last modified on June 2, 2026