v1
latestOpenAPI 3.0.12026-07-248498266.5 KBMeters
List Meters
Arcadia retrieves Meters from utility providers using the credentials that are submitted. There can be one or more meters behind a credential. This endpoint is pageable
This endpoint supports Sandbox Mode.
get/plug/meters
Query parameters
searchstring
A search query string. See this page for more information.
The searchable fields for this endpoint are:
- accountId
- accountNumber
- bulbType
- correlationIds
- createdAt
- createdBy
- credentialIds
- currentTariff.tariffName
- customData1
- customData10
- customData2
- customData3
- customData4
- customData5
- customData6
- customData7
- customData8
- customData9
- generalDescriptionAsPrinted
- id
- isIntervalsDormant
- isIntervalsProductActive
- isLocationRecommendationIgnored
- isStandalone
- lastModifiedAt
- lastModifiedBy
- latestIntervalAt
- latestIntervalsCheckedAt
- latestStatementDate
- meterNumber
- nextExpectedPostDate
- normalizedMeterNumber
- normalizedPointOfDeliveryNumber
- normalizedPreviousMeterNumber
- pipeType
- pointOfDeliveryNumber
- previousMeterNumber
- provider.name
- providerId
- serviceAddress.fullAddress
- serviceType
- site.serviceAddress.fullAddress
- site.siteCode
- site.siteFacilityType
- site.siteNumber
- site.siteRegion
- site.siteSubRegion
- siteId
- siteName
- statementIds
- status
- statusDetail
- voidedAt
globalSearchstring
A global search query string. See this page for more information.
pageinteger
Zero-based page index (0..N)
sizeinteger
The size of the page to be returned
sortstring[]
Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.
Headers
Arcadia-Versionstring required
The Arcadia-Version for the request
Response
OK