Retrieve an Entity - re.alto Docs

API Reference

Core Resources

Entities
- The Entity object
- GET
  Retrieve an Entity
- GET
  List all Entities
- Sharing access
Collectives
Tenants

Onboarding API

Entity Onboarding
Collective Onboarding
Guided Onboarding

Readings API

Readings
Aggregations

Commands API

Charge Sessions API

GET
List all Charge Sessions

Entity Settings

Features
Locations
Battery Capacity
Heated Area
Disaggregators
Custom Properties

Offboarding API

Offboard Entities

GET

entities

{entityId}

curl --request GET \
  --url https://platform.realto.io/api/v1/entities/{entityId} \
  --header 'Authorization: Bearer <token>'

{
  "created": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isOnline": true,
  "lastSeen": "2023-11-07T05:31:56Z",
  "properties": "<any>",
  "reference": {
    "manufacturer": "<string>",
    "type": "<string>",
    "reference": "<string>"
  },
  "type": "Battery"
}

Authorizations

Authorization

string

header

required

Access Token Authentication

Path Parameters

entityId

string

required

The id of the Entity

Response

200

application/json

created

string

isOnline

boolean | null

lastSeen

string | null

properties

any | null

reference

object

type

enum<string>

Available options:

Battery,

Boiler,

ChargePole,

EV,

HeatPump,

PV,

RetrofitMeter,

SmartMeter

Was this page helpful?

The Entity object List all Entities

curl --request GET \
  --url https://platform.realto.io/api/v1/entities/{entityId} \
  --header 'Authorization: Bearer <token>'

{
  "created": "2023-11-07T05:31:56Z",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isOnline": true,
  "lastSeen": "2023-11-07T05:31:56Z",
  "properties": "<any>",
  "reference": {
    "manufacturer": "<string>",
    "type": "<string>",
    "reference": "<string>"
  },
  "type": "Battery"
}