Get Properties

get

https://api.genability.com/rest/public/properties

Return a full or filtered list of Properties.

Query Params

dataType

string

Filters the result set to only include properties that have the specified dataType (Optional)

family

string

Filters the result by the family. Examples of family include "billing", "metering" and "connection". Look at the properties to see more examples of the family (Optional).

keySpace

string

Filters the result by the key space. Possible values include "electricity" and "solarPv" (Optional)

entityId

int64

Filters the result set to only include properties that belong to this entityId. entityType must also be specified, otherwise this is ignored (Optional).

entityType

string

Filters the result set to only include properties that belong to this entityType. entityId must also be specified, otherwise this is ignored. Currently, the only supported value is "LSE" (Optional)

excludeGlobal

boolean

Filters the result set to only include entity-specific properties.

Responses

Language

Credentials

Basic

base64

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200200

400400