HomeGuidesAPI ReferenceChangelog
Log In
API Reference
Start typing to search…

List Meters

get
https://api.arcadia.com/plug/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.

Query Params
string

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
string

A global search query string. See this page for more information.

integer
Defaults to 0

Zero-based page index (0..N)

integer
Defaults to 20

The size of the page to be returned

sort
array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort
Headers
string
required
Defaults to 2024-02-21

The Arcadia-Version for the request

Response

Updated 8 months ago

Language
Credentials
OAuth2
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 8 months ago