Skip to main content
GET
List all devices

Authorizations

Authorization
string
header
required

Bearer token obtained from POST /auth/tokens.

Query Parameters

device_type
enum<string>

Return only devices of this device type.

Available options:
BATTERY_STORAGE,
ELECTRIC_VEHICLE,
EV_CHARGER,
AIR_CONDITIONER,
HEAT_PUMP,
WATER_HEATER,
PV_SYSTEM,
POWER_GENERATOR,
OTHER
location_id
string

Return only devices at this location.

reference_id
string

Your own reference, for example an ID from your system.

limit
integer
default:30

Maximum number of objects to return per page, default 30. Maximum 100.

Required range: 1 <= x <= 100
cursor
string

Pagination cursor. Pass next_cursor from the previous response unchanged; omit for the first page. A cursor used with different parameters returns 400 cursor_invalid.

Response

200 OK: a paginated list of devices.

Standard envelope for paginated list endpoints.

object
enum<string>
default:list
required

Object type.

Available options:
list
url
string
required

URL for this list.

Example:

"/users"

next_cursor
string | null
required

Opaque cursor for the next page. Pass it as cursor on the next request. null on the last page. Do not stop on a short or empty data array.

Example:

"djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx"

data
Device · object[]
required

The page of results.