Skip to content
Teleport

Listing devices

Retrieve a list of all devices in your organization. This route is rate limited to 10 requests per 5 minutes per API key. It uses pagination with 100 results per page.


REQUEST
method + URL
GET https://api.teleport.withthegrid.com/v2/device/
query string (in TS)
{
offset?: string;
}
query string details
offset?
RESPONSE
successful responses
200
List of devices
body for status 200 (in TS)
{
devices: {
hashId: string;
name: string;
cloudApi: "READ" | "READ_WRITE";
reportingInterval: number;
dataForwarding: boolean;
inProduction: boolean;
isOnline: boolean;
assets: {
type: string;
category: "solar" | "wind" | "meter" | "battery" | "heat" | "irradianceSensor" | "windSensor" | "temperatureSensor" | "ev" | "generator" | "misc" | "relay" | "heatPump";
identifier: string;
nominalActivePower: number | null;
}[];
controllers: {
type: string;
identifier: string;
schedule: (ApplyAfrrDeltaSetpoint | LimitPower)[] | null;
}[];
}[];
}
details for body status 200 (in TS)
devices[].cloudApi

"READ" means that the device is visible in the Teleport Cloud API, but requests to schedule asset commands or setting asset parameters for them will be rejected. "READ_WRITE" means that scheduling asset commands and setting asset parameters is allowed.

devices[].reportingInterval

In seconds. Applies to the default report type of each asset, like "solarPower", "windPower" and "batteryPower". Does not apply to auxiliary reports like "batteryPower.flash".

devices[].dataForwarding

Whether data forwarding is enabled for this device. See https://teleport.withthegrid.com/data-forwarding/ for more information.

devices[].inProduction

When the device is in production data is forwarded (if enabled) and the device can be steered (if enabled)

devices[].isOnline

Whether the device is connected to the Teleport cloud via ethernet or its cellular fallback.

devices[].assets[].nominalActivePower

Total nominal active power of the asset in W, as configured by us. When possible, this value is verified with data from the asset. Can be null if not available.

devices[].assets[].schedule

The latest schedule sent in through our cloud API confirmed by this device. Instructions coming from control loops or the local API are not included.

devices[].controllers[].schedule

The latest schedule sent in through our cloud API confirmed by this device. Instructions coming from control loops or the local API are not included.

error responses (next to generic errors)
No other error responses than the generic ones.