Skip to main content
POST
/
assets
/
byids
JavaScript SDK
const assets = await client.assets.retrieve([{id: 123}, {externalId: 'abc'}]);
{
  "items": [
    {
      "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": {
        "type": "Feature",
        "geometry": {
          "type": "Point",
          "coordinates": [
            123
          ]
        },
        "properties": {}
      }
    }
  ]
}

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.

Body

application/json

All provided IDs and external IDs must be unique.

items
object[]
required
Required array length: 1 - 1000 elements
ignoreUnknownIds
boolean
default:false

Ignore IDs and external IDs that are not found

aggregatedProperties
enum<string>[]

Set of aggregated properties to include

Available options:
childCount,
path,
depth

Response

Response with list of assets.

items
object[]
required
Last modified on April 23, 2026