get
https://api.genability.com/rest/public/properties
Return a list of Property Keys and sub-property keys based on search criteria.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to return a list of Property Keys and sub-property keys based on search criteria.
When to use this endpoint
Use GET /rest/public/properties when you need to:
- Find Property Keys used by tariffs or calculations.
- Filter properties by
dataType,family, orkeySpace. - Retrieve LSE-specific properties by using
entityTypeandentityId. - Find
LOOKUPProperty Keys before querying lookup table values.
Common filters
| Parameter | Type | Description |
|---|---|---|
dataType | String | Filters results to properties with the specified data type. |
family | String | Filters results by property family, such as billing, metering, or connection. |
keySpace | String | Filters results by keyspace, such as electricity, market, tariff, or solarPv. |
entityId | Long | Filters to properties that belong to the specified entity. Use with entityType. |
entityType | String | Filters to properties that belong to the specified entity type. Use with entityId. |
excludeGlobal | Boolean | Filters results to only entity-specific properties. |
Related endpoints
Request Parameters
Along with the standard pagination parameters, searching and sorting parameters, and the required security parameters, the following parameters are available as part of the request: