Skip to main content
GET
/
document
/
{document_id}
/
demandmeters
Get Demand Meters by Document
curl --request GET \
  --url https://external.nectarclimate.com/v2/document/{document_id}/demandmeters \
  --header 'X-API-KEY: <api-key>'
{
  "totalDemandMeters": 123,
  "demandMeters": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "created": "2023-11-07T05:31:56Z",
      "startDate": "2023-12-25",
      "endDate": "2023-12-25",
      "usage": "<string>",
      "usageUnits": "J",
      "serviceAddress": "<string>",
      "meter": "<string>",
      "site": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "dataCollectionStopDate": "2023-12-25",
        "externalId": "<string>",
        "address": "<string>",
        "path": [
          "<string>"
        ],
        "occupancyPercent": "<string>"
      },
      "identifiers": [
        {
          "rawName": "<string>",
          "value": "<string>",
          "name": "<string>"
        }
      ],
      "timeOfUse": "PEAK",
      "updated": "2023-11-07T05:31:56Z",
      "isEstimated": true
    }
  ]
}

Authorizations

X-API-KEY
string
header
required

Path Parameters

document_id
string<uuid>
required

ID of the document to retrieve.

Response

Serializer for document demand meters response.

totalDemandMeters
integer
required

Total number of demand meters.

demandMeters
object[]
required

List of demand meters.