Skip to main content
GET
/
entities
/
asset
Get Assets
curl --request GET \
  --url https://api-sandbox.axle.energy/entities/asset \
  --header 'Authorization: Bearer <token>'
{
  "assets": [
    {
      "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
      }
    }
  ],
  "total_num_assets": 123,
  "total_num_pages": 123,
  "page_number": 123
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer
default:10

Maximum number of assets to return (1-5000)

Required range: 1 <= x <= 5000
​
offset
integer
default:0

Number of assets to skip for pagination

Required range: x >= 0

Response

Page of assets with pagination info

Paginated response for asset listings.

​
assets
AssetResponse · object[]
required

List of assets for the current page

​
total_num_assets
integer
required

Total number of assets available

​
total_num_pages
integer
required

Total number of pages available

​
page_number
integer
required

Current page number (1-based)