Skip to main content
GET
List all devices

Authorizations

Authorization
string
header
required

Authenticate with the bearer_token obtained from the authentication endpoint.

Query Parameters

device_type
enum<string>

Return only devices of this device type.

Available options:
BATTERY_STORAGE,
ELECTRIC_VEHICLE,
EV_CHARGER,
PV_SYSTEM,
OTHER
oem_id
string

Return only devices from this OEM. Get OEM IDs from list all OEMs.

Pattern: ^oem_[A-Za-z0-9]+$
Example:

"oem_6a3a8dada72cd0a249ff9528"

location_id
string

Return only devices at this location, for example to find the devices sharing one grid connection point.

limit
integer
default:30

Maximum number of objects to return per page. Between 1 and 100, default 30. Values above 100 are clamped to 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

Device list response.

object
enum<string>
required

Object type, list.

Available options:
list
Example:

"list"

url
string
required

URL slug for the object.

Example:

"/devices"

next_cursor
string | null
required

Cursor for the next page. Pass it as cursor. null on the last page. Page until it is null, even if data is short or empty.

Example:

"djF8ZXZ0fGE5ZjN8NjYxNjc3ODdjMTY1MmIzZmJlYmE1ZjAx"

data
Device · object[]
required