Skip to navigation
Configuration APIMeter Property Variables

Get a list of meter property variables

Requires the METER_PROPERTY_VARIABLE.VIEW permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

versionstringRequiredDefaults to 1
version

Headers

x-platform-idstringOptional
Platform ID.

Query parameters

namestringOptional

Filter by name (case-insensitive, contains).

meter_property_idstringOptional
Filter by meter property id.
typestringOptional
Filter by type.
statuses[]list of stringsOptional
Filter by status.
referencestringOptional
Filter by reference.
limitintegerOptional
The amount of records shown in the list.
pageintegerOptional
The page which is going to be shown.
order_bystringOptional
The parameter by which the response is ordered.
order_directionstringOptional
The order direction by which the response is ordered.

Response

OK
datalist of objects
limitinteger or nullOptional
pageinteger or nullOptional
total_number_of_pagesinteger or nullOptionalDeprecated

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error