Search Consumption Meters

post

https://api.facilioo.de/api/consumption-meters/search

Search Consumption Meters

Performs a search applying filtering, sorting, and pagination criteria within the consumption meters, that the caller is permitted to query. Returns a paginated list matching the search conditions.

Module: Consumptions

Returns: Consumptions → Meters → ConsumptionMeterRead (paginated)

Authorization

Required Token Scopes: Platform (0)

Allowed Party Types (Account Role): Admin (1), Property Management Company (2), User (7)

This will be evaluated against your used access token.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

PageSize

int32

PageNumber

int32

Body Params

Represents a search request for filtering and sorting consumption meters based on various criteria. The default sorting is ascending by entity id. Sorting can be applied using the format: {"orderBy": ["attributename1 desc", "attributename2 asc"]} or {"orderBy": ["attributename"]}. If the sorting order is not provided or entered anything but desc, fallback order is ascending. OrderByNextReadingDate: Sorts the meter list by the next scheduled reading date, {"orderBy": ["nextreadingdate desc"]}. In case we are sorting by attributes that are related to another entity, then we use format {"orderBy": ["relatedentity.sortingcolumname asc"]}. OrderByPropertyAddress: Sorts the meter list by property address (first by street, then by city), {"orderBy": ["meteredproperty.fullstreet asc"]}. OrderByProjectName: Sorts the meter list by project name, {"orderBy": ["tenant.title desc"]}. OrderByMeter: Sorts the meter list first by meter type (e.g., Kaltwasserzähler/Gaszähler) and then by meter number (e.g., 'CA-123'), { "orderBy": ["type.metername desc"]}. OrderByLastReadingDate: Sorts the meter list by the most recent recorded reading date using {"orderBy": ["readings.max(readingdate) asc"]}. Since this includes a one-to-many (1:n) relationship, the sorting is applied first on the related entity (readings), followed by the main entity (meter).

searchTerm

string | null

Searches the ConsumptionMeter's OfficialMeteringPointId, Number, Location, and DeviceId.

ids

array of int32s | null

ids

orderBy

array of strings | null

orderBy

tenantId

int32 | null

Filters meters by the tenant, use this to retrieve meters associated with a specific tenant. Example: 11.

meteredPropertyId

int32 | null

Filters meters by the property, use this to retrieve meters linked to a specific property. Example: 10.

meteredUnitId

int32 | null

Filters meters by the unit, use this to retrieve meters associated with a specific unit. Example: 111.

typeId

int32 | null

Filters meters by the meter type, such as Kaltwasserzähler or Gaszähler. The Consumption name comes from the ConsumpType entity.

providerPartyId

int32 | null

Filters meters by the ID of the provider. Example: 111.

accessibleByPartyId

int32 | null

Filters meters that are accessible by a certain party. Example: 32.

isAccessibleByPartyEmpty

boolean | null

Filters meters based on whether there are accessible parties at all. Set to true to retrieve meters with no accessible parties, and to false to retrieve meters with at least one accessible party set. Example: false.

nextReadingDateBefore

date-time | null

Filters meters with the next reading date on or before the specified date. Format: YYYY-MM-DD. Example: 2025-12-31.

nextReadingDateAfter

date-time | null

Filters meters with the next reading date on or after the specified date. Format: YYYY-MM-DD. Example: 2025-12-31.

isNextReadingDateEmpty

boolean | null

Filters meters based on whether the next reading date is empty. Set to true to retrieve meters with no next reading date, and to false to retrieve meters with a next reading date set. Example: false.

isNextReadingDateInFutureOrEmpty

boolean | null

deprecated

Filters meters based on whether the next reading date is empty or reading date is in the future. Example: false.

hasReadings

boolean | null

Filters meters which do have readings. Example: true.

notificationDateBefore

date-time | null

Filters meters with the notification date on or before the specified date. Format: YYYY-MM-DD. Example: 2025-12-31.

notificationDateAfter

date-time | null

Filters meters with the notification date on or after the specified date. Format: YYYY-MM-DD. Example: 2025-12-31.

isNotificationDateEmpty

boolean | null

Filters meters based on whether the notification date is empty. Set to true to retrieve meters with no notification date, and to false to retrieve meters with a notification date set. Example: false.

consumptionMeterLevel

int32 | null

enum

Possible values:

1 = Property
2 = Unit

Allowed:

isArchived

boolean | null

Filters meters by their property / unit archived status. Possible values: null (all), true (only archived), or false (only non-archived).

Headers

Accept-Language

string

Language preference header. Allowed languages: German (en-DE).

api-version

string

Defaults to 2.0

API version to use (1 or 2) either with trailing .0 or without. Defaults to 2.0, if omitted. Can be prefilled based on the currently selected API Definition (Swagger UI).

Responses

401

Error: Unauthorized

200OK