ENenphase
System Details

Search and filter systems

Changed on

Search and filter systems. Provide only valid values in request parameters. Empty values will be ignored. Invalid keys will be rejected.

post/api/v4/systems/search

Request

Query parameters

pageinteger

The page to be returned. Default=1, Min=1, e.g=2

sizeinteger

Maximum number of records shown per page. Default=10, Min=1, Max=1000, e.g=5

live_streamboolean

Indicates whether the live_stream field should be included in the response (true to include, false to omit).

Request body

sort_by'id' | '-id'

Returns list of systems sorted by <sort_by> field. To get ASC order sorted list, user sort_by = id. To get DESC order sorted list, use sort_by = -id. By default, the list is sorted by ascending order of system ID.

Response

List of Systems

totalinteger

Total number of systems available

current_pageinteger

Current page of the systems result. Default is 1

sizeinteger

Max number of records from API per page is 100. Default is 10.

countinteger

Total number of systems actually returned for the current page

itemsstring

Named key of the list data. In this endpoint, it is systems

Changes