GET
/
v1
/
devices
/
{device_id}
Retrieve a device
curl --request GET \
  --url https://api.amberflow.io/v1/devices/{device_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "991fced7-024c-4162-abbe-320fec9de64f",
  "created_at": "2024-09-23T12:00:00.000Z",
  "location_id": "loc_lBHRyynPDIsPJNmj",
  "name": "My Solar Inverter",
  "device_type": "SOLAR_INVERTER",
  "brand": "ENPHASE",
  "icon_url": "https://database.amberflow.io/storage/v1/object/public/media/logos/enphase-logo-w200.png"
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
device_id
string
required

Response

Successful Response

​
id
string
required
Examples:

"991fced7-024c-4162-abbe-320fec9de64f"

​
created_at
string<date-time>
required
Examples:

"2024-09-23T12:00:00.000Z"

​
location_id
string
required
Examples:

"loc_lBHRyynPDIsPJNmj"

​
name
string
required

The name of the device

Examples:

"My Solar Inverter"

​
device_type
enum<string>
required

The type of the device

Available options:
SOLAR_INVERTER,
BATTERY,
METER
Examples:

"SOLAR_INVERTER"

"BATTERY"

"METER"

​
brand
enum<string>
required

The brand of the device

Available options:
ENPHASE,
HUAWEI,
SOLAR_EDGE,
SMA
Examples:

"ENPHASE"

"HUAWEI"

"SOLAR_EDGE"

"SMA"

​
icon_url
string
required

The URL to the icon of the device

Examples:

"https://database.amberflow.io/storage/v1/object/public/media/logos/enphase-logo-w200.png"