AXaxle
4. Assets

Get Asset By External Id

Changed on

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}

Request

  • Base URL
    https://api-sandbox.axle.energy
  • URL
    https://api-sandbox.axle.energy/entities/asset/external-id/{external_id}
  • Auth
    OAuth 2
    Password
    Token URL: auth/token-form

Path parameters

external_idstring required

Response

Asset details

idstring uuid required

Axle's internal UUID for the asset

external_idstring required

Vendor-specific identifier for the asset

type'boundary meter' | 'charger' | 'battery' | 'heat pump' | 'hot water tank' | 'frequency meter' | 'electric_vehicle' | 'pv inverter' required
site_idstring uuid required

ID of the site where the asset is located

needs_reauthorisationboolean

Whether the owner must re-authorise their device connection to keep taking part in events

Changes

  • b0b07b1dbf12Revision changes
    • info

      added the optional property to the response with the status

    • info

      added to the response property allOf list for the response status

    • info

      removed from the response property allOf list for the response status