---
updatedAt: 2025-08-15T15:45:24.000Z
agentTools:
projectIndex: https://docs.arcadia.com/v1.0-Utility-Cloud/llms.txt
---
# List Meters
Urjanet 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; see here for more details.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"title": "Utility Cloud",
"description": "Utility Cloud",
"version": "2.0"
},
"servers": [
{
"url": "https://api.urjanet.com/"
}
],
"paths": {
"/utility/meters": {
"get": {
"tags": [
"Meters"
],
"description": "Urjanet 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; see here for more details.",
"operationId": "List Meters",
"summary": "List Meters",
"parameters": [
{
"name": "search",
"in": "query",
"description": "An RSQL query string (see here for details.) You can find a list of searchable fields here.",
"schema": {
"type": "string"
}
},
{
"description": "Zero-based page index (0..N)",
"in": "query",
"name": "page",
"schema": {
"type": "integer",
"default": 0
}
},
{
"description": "The size of the page to be returned",
"in": "query",
"name": "size",
"schema": {
"type": "integer",
"default": 20
}
},
{
"description": "Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.",
"in": "query",
"name": "sort",
"schema": {
"type": "array",
"items": {
"type": "string"
}
}
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PagedPublicMeterResource"
}
},
"application/hal+json": {
"schema": {
"$ref": "#/components/schemas/PagedPublicMeterResource"
}
}
}
}
},
"security": [
{
"BearerAuth": []
},
{
"UnifiedAuth": []
},
{
"APIKey": []
}
]
}
}
},
"security": [
{
"BearerAuth": []
}
],
"x-amazon-apigateway-api-key-source": "AUTHORIZER",
"x-amazon-apigateway-binary-media-types": [
"application/pdf",
"application/zip",
"application/octet-stream"
],
"components": {
"securitySchemes": {
"BearerAuth": {
"type": "http",
"scheme": "bearer",
"bearerFormat": "JWT"
},
"UnifiedAuth": {
"type": "apiKey",
"name": "Authorization",
"in": "header",
"x-amazon-apigateway-authtype": "custom",
"x-amazon-apigateway-authorizer": {
"authorizerUri": "arn:aws:apigateway:us-east-1:lambda:path/2015-03-31/functions/arn:aws:lambda:us-east-1:291789168161:function:${stageVariables.authenticatorFunctionName}/invocations",
"authorizerCredentials": "arn:aws:iam::291789168161:role/${stageVariables.authenticatorRoleName}",
"authorizerResultTtlInSeconds": 300,
"type": "token"
}
},
"APIKey": {
"type": "apiKey",
"name": "x-api-key",
"in": "header"
}
},
"schemas": {
"PageMetadata": {
"type": "object",
"properties": {
"number": {
"type": "integer",
"format": "int64"
},
"size": {
"type": "integer",
"format": "int64"
},
"totalElements": {
"type": "integer",
"format": "int64"
},
"totalPages": {
"type": "integer",
"format": "int64"
}
},
"title": "PageMetadata"
},
"PagedPublicMeterResource": {
"required": [
"_embedded",
"_links",
"page"
],
"properties": {
"_embedded": {
"properties": {
"meters": {
"items": {
"$ref": "#/components/schemas/PublicMeterResource"
},
"type": "array"
}
},
"type": "object"
},
"_links": {
"properties": {
"first": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"last": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"next": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"prev": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
},
"page": {
"$ref": "#/components/schemas/PageMetadata"
}
},
"title": "PagedPublicMeterResource",
"type": "object"
},
"PublicUtilityAddressResource": {
"required": [
"addressType",
"city",
"country",
"fullAddress",
"postalCode",
"recipient",
"state",
"streetLine1",
"streetLine2"
],
"properties": {
"addressType": {
"enum": [
"FULL",
"PARTIAL"
],
"type": "string"
},
"city": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
},
"country": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
},
"fullAddress": {
"type": "string",
"description": "The max length of this field is 500 characters. This field is searchable.",
"nullable": true
},
"postalCode": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
},
"recipient": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
},
"state": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
},
"streetLine1": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
},
"streetLine2": {
"type": "string",
"description": "This field is searchable.",
"nullable": true
}
},
"title": "PublicUtilityAddressResource",
"type": "object"
},
"PublicCustomDataResource": {
"additionalProperties": {
"type": "string"
},
"title": "PublicCustomDataResource",
"nullable": true,
"type": "object"
},
"PublicMeterResource": {
"required": [
"accountIds",
"accountNumbers",
"bulbType",
"createdBy",
"createdDate",
"currentTariff",
"customData",
"entityId",
"lastModifiedBy",
"lastModifiedDate",
"latestStatementDate",
"meterConstantMultiplier",
"meterNumber",
"meterStatus",
"nextExpectedPostDate",
"normalizedMeterNumber",
"normalizedPodNumber",
"normalizedPreviousMeterNumber",
"pipeType",
"podNumber",
"previousMeterConstantMultiplier",
"previousMeterNumber",
"provider",
"providerName",
"serviceAddress",
"serviceDescription",
"serviceType",
"site"
],
"properties": {
"accountIds": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the account IDs (UUID) this meter belongs to. There is no max length for this field. This field is searchable."
},
"accountNumbers": {
"type": "array",
"items": {
"type": "string"
},
"description": "An array of the account numbers this meter belongs to. There is no max length for this field. This field is searchable."
},
"bulbType": {
"type": "string",
"description": "This field is searchable",
"nullable": true
},
"createdBy": {
"type": "string",
"description": "This field is searchable",
"nullable": true
},
"createdDate": {
"format": "date-time",
"type": "string",
"description": "This field is searchable"
},
"customData": {
"$ref": "#/components/schemas/PublicCustomDataResource"
},
"entityId": {
"type": "string",
"description": "Meter ID (UUID)"
},
"lastModifiedBy": {
"type": "string",
"description": "This field is searchable"
},
"lastModifiedDate": {
"format": "date-time",
"type": "string",
"description": "This field is searchable"
},
"meterConstantMultiplier": {
"type": "number",
"nullable": true
},
"meterNumber": {
"type": "string",
"description": "This field is searchable",
"nullable": true
},
"meterStatus": {
"enum": [
"CURRENT",
"NOT_CURRENT",
"INACTIVE",
"FIX"
],
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"nextExpectedPostDate": {
"format": "date",
"nullable": true,
"type": "string",
"description": "This field is searchable"
},
"normalizedMeterNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"normalizedPodNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"normalizedPreviousMeterNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"pipeType": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"podNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"previousMeterConstantMultiplier": {
"type": "number",
"nullable": true
},
"previousMeterNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"provider": {
"$ref": "#/components/schemas/PublicUtilityProviderResource"
},
"providerName": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"serviceAddress": {
"$ref": "#/components/schemas/PublicUtilityAddressResource",
"description": "This field is searchable"
},
"serviceDescription": {
"type": "string",
"nullable": true,
"description": "This field is searchable"
},
"serviceType": {
"enum": [
"electric",
"lighting",
"natural_gas",
"water",
"sewer",
"irrigation",
"district_heat",
"chilled_water"
],
"type": "string",
"description": "This field is searchable"
},
"site": {
"$ref": "#/components/schemas/PublicSiteResource",
"nullable": true,
"description": "This field is searchable"
},
"_links": {
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"accounts": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"credentials": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"meterData": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"provider": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"site": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"statements": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
},
"title": "PublicMeterResource",
"type": "object"
},
"PublicSiteResource": {
"required": [
"createdBy",
"createdDate",
"entityId",
"facilityType",
"id",
"lastModifiedBy",
"lastModifiedDate",
"meterIds",
"region",
"serviceAddress",
"siteCode",
"siteName",
"siteNumber",
"subRegion"
],
"properties": {
"createdBy": {
"type": "string",
"nullable": true
},
"createdDate": {
"format": "date-time",
"type": "string"
},
"entityId": {
"type": "string",
"description": "Site ID (UUID)"
},
"facilityType": {
"type": "string",
"nullable": true
},
"lastModifiedBy": {
"type": "string",
"nullable": true
},
"lastModifiedDate": {
"format": "date-time",
"type": "string"
},
"region": {
"type": "string",
"nullable": true
},
"serviceAddress": {
"$ref": "#/components/schemas/PublicUtilityAddressResource",
"description": "This field is searchable.",
"nullable": true
},
"siteCode": {
"type": "string",
"nullable": true,
"description": "This field is searchable."
},
"siteName": {
"type": "string",
"description": "This field is searchable."
},
"siteNumber": {
"type": "string",
"nullable": true,
"description": "This field is searchable."
},
"subRegion": {
"nullable": true,
"type": "string"
},
"_links": {
"properties": {
"self": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"accounts": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"credentials": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"events": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"meters": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
},
"statements": {
"type": "object",
"properties": {
"href": {
"type": "string"
}
}
}
}
}
},
"title": "PublicSiteResource",
"type": "object"
},
"PublicUtilityProviderResource": {
"required": [
"country",
"id",
"providerName",
"supportsCredentialValidation",
"website"
],
"properties": {
"country": {
"type": "string",
"nullable": true,
"description": "The provider's country"
},
"entityId": {
"type": "string",
"description": "The ID of the provider"
},
"providerName": {
"type": "string",
"description": "The provider's name"
},
"supportsCredentialValidation": {
"type": "boolean",
"nullable": true,
"description": "Whether or not the provider supports credential validation"
}
},
"title": "PublicUtilityProviderResource",
"type": "object"
}
}
},
"tags": [
{
"name": "Meters"
}
],
"x-readme": {
"explorer-enabled": true,
"proxy-enabled": true,
"samples-enabled": true
}
}
```