Get asset by external id

Get a specific asset by its external ID (vendor-specific identifier).

Returns the asset details if it exists. This is useful for integrations where the external system ID is known but not the Axle UUID.

GET /entities/asset/external-id/{external_id}

Get Asset By External Id

cURL

curl --request GET \
  --url https://api-sandbox.axle.energy/entities/asset/external-id/{external_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "type": "boundary meter",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": {
    "power_kw": 1,
    "capacity_kwh": 1
  }
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

external_id · string · required

Response

200

application/json

Asset details

Response model for asset information.

id · string<uuid> · required

Axle's internal UUID for the asset

external_id · string · required

Vendor-specific identifier for the asset

type · enum<string> · required

Type of asset

Available options: boundary meter, charger, battery, heat pump, hot water tank, frequency meter, electric_vehicle, pv inverter

site_id · string<uuid> · required

ID of the site where the asset is located

properties · Properties · object

Optional asset properties

Show child attributes