get
https://api.genability.com/rest/public/properties
Return a full or filtered list of Properties.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve a full or filtered list of property keys.
Use this endpoint to find metadata keys used by tariffs, calculations, applicability rules, and lookup-backed values. You can filter by data type, family, keyspace, or entity-specific ownership.
Resource URI
GET /rest/public/propertiesQuery parameters
| Parameter | Type | Description |
|---|---|---|
dataType | String | Return only properties with this data type, such as STRING, CHOICE, BOOLEAN, DATE, DECIMAL, INTEGER, FORMULA, LOOKUP, or DEMAND. Optional. |
family | String | Return properties in a family, such as billing, metering, or connection. Optional. |
keySpace | String | Return properties in a keyspace, such as electricity or solarPv. Optional. |
entityId | Long | Return properties that belong to this entity ID. Requires entityType; otherwise ignored. Optional. |
entityType | String | Return properties that belong to this entity type. Requires entityId; otherwise ignored. Currently supports LSE. Optional. |
excludeGlobal | Boolean | When true, returns only entity-specific properties. Optional. |
For the full PropertyKey data model and examples, see Properties.
Example
GET /rest/public/properties?dataType=LOOKUP&keySpace=marketA successful response returns a standard response payload with type set to PropertyKey and results containing matching property keys.