Skip to main content
GET
/
v1
/
entities
/
{entityId}
Retrieve an Entity
curl --request GET \
  --url https://api.traxes.io/connect/v1/entities/{entityId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "Battery",
  "brand": "<string>",
  "identifier": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "name": "<string>",
  "parentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "isOnline": true,
  "properties": "<unknown>",
  "lastSeen": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Access Token Authentication

Path Parameters

​
entityId
string<uuid>
required

The id of the Entity

Response

OK

An Entity

​
id
string<uuid>
required

The id of the Entity

​
type
enum<string>
required
Available options:
Battery,
ChargePoint,
EV,
HeatPump,
SolarPlant,
RetrofitMeter,
Meter,
Inverter
​
brand
string | null
required

The brand information of the Entity

​
identifier
string | null
required

The reference of the Entity

​
created
string<date-time>
required

The date and time the entity was created

​
name
string | null

The name of the Entity. Used like a label or a description.

​
parentId
string<uuid> | null

The parent id of the Entity

​
isOnline
boolean

A value indicating whether the entity is online.

​
properties
any | null

The custom properties of the Entity

​
lastSeen
string<date-time> | null

The date and time the entity was last seen