Skip to main content
GET
/
entities
/
asset
/
external-id
/
{external_id}
Get Asset By External Id
curl --request GET \
  --url https://api-sandbox.axle.energy/entities/asset/external-id/{external_id} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "external_id": "<string>",
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "properties": {
    "power_kw": 1,
    "capacity_kwh": 1
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.axle.energy/llms.txt

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

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

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