URL Expired

The URL for this request expired after 30 days.

API Parameters

page_token

• Type: string
• Description: If there are more meters to fetch, this token will be populated as next_page_token in the response. Use it to fetch the next page.

page_size

• Type: int32
• Range: 1 to 500
• Defaults to: 500
• Description: Amount of results to return. Defaults to 500.

transmission_region

• Type: string
• Enum Values: CAISO, ERCOT, NYISO, ISONE, PJM, SERC, WECC_SW, WECC_PC
• Description: Defines the transmission region of the meter.

customer_classification

• Type: string
• Enum Values: RESIDENTIAL, COMMERCIAL
• Description: Whether this is a residential (home) asset or a commercial (business) asset.

meter_ids

• Type: array of uuids
• Description: Length between 0 and 1000. Meter ID.

partner_references

• Type: array of strings
• Description: Filter meters with a partner reference that is included in this list. Length between 1 and 1000.

global_enrollment_statuses

• Type: array of objects
• Description: Filter meters with a global_enrollment_status that is included in this list. Length between 1 and 5.

meter_types

• Type: array of objects
• Description: The type of meter. Length between 1 and 20.

load_types

• Type: array of objects
• Description: The type of meter. Length between 1 and 20.

customer_groups

• Type: array of strings
• Description: The customer group associated with the meter. Length between 1 and 20.

tags

• Type: array of strings
• Description: A tag associated with the meter. Length between 1 and 20.

last_modified_date_time

• Type: date-time
• Description: Find meters that have been modified after this date.

created_after_date_time

• Type: date-time
• Description: Find meters created after this date.

created_before_date_time

• Type: date-time
• Description: Find meters created before this date.

partner_action_required

• Type: boolean
• Defaults to: false
• Description: When true, returns only meters that require partner action. False returns all meters.

exclude_archived

• Type: boolean
• Defaults to: false
• Description: When true, archived meters are excluded in the response. By default they are included.

connection_reference_ids

• Type: array of strings
• Description: Filter by a set of connection reference IDs, which are the refIDs supplied during completed Leap Connect authorizations. Length between 1 and 100.

action_type

• Type: array of objects
• Description: The type of action required. Length between 1 and 20.

Responses

200 Success

• Description: Successful response with a list of meters that match the search criteria.

400 Bad Request

• Description: The request is not valid.

401 Unauthorized

• Description: You are not authorized to perform this operation.

403 Forbidden

• Description: You do not have the necessary permissions for this operation.

404 Not Found

• Description: Meter not found.

500 Internal Server Error

Example Request

curl --request POST \
     --url https://api.staging.leap.energy/v2/meters/enrollments/search \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data '{\n  "page_size": 500,\n  "partner_references": [],\n  "global_enrollment_statuses": [],\n  "meter_types": [],\n  "load_types": [],\n  "customer_groups": [],\n  "tags": [],\n  "partner_action_required": false,\n  "exclude_archived": false,\n  "connection_reference_ids": [],\n  "action_type": []\n}\\n'  

Example Response

{
  "next_page_token": "PAGE_TOKEN",
  "meters": [
    {
      "meter_id": "11111111-1111-1111-1111-111111111111",
      "is_archived": false,
      "customer_group": "",
      "global_enrollment_status": "ELIGIBLE",
      "participation_preferences": [
        {
          "participation_preference": "PARTICIPATE",
          "start_time": "2024-04-24T16:03:06Z",
          "end_time": "9000-12-31T23:59:59.999999999Z"
        }
      ],
      "program_enrollment": [
        {
          "program_identifier": "PSEGLI-CSRP",
          "delivery_period": "PSEGLI-CSRP_2025_MAY_SEP",
          "delivery_period_start_date_time": "2025-05-01T04:00:00Z",
          "delivery_period_end_date_time": "2025-09-30T04:00:00Z",
          "enrollment_status": "INELIGIBLE",
          "enrollment_deadlines": [
            {
              "enrollment_deadline_date_time": "2025-03-15T04:00:00Z",
              "activation_date_time": "2025-05-01T04:00:00Z"
            }
          ]
        }
      ],
      "required_actions": { ... },
      "connection_references": ["test_jae"],
      "tags": [],
      "partner_reference": "test_meter",
      "transmission_region": "NYISO",
      "customer_classification": "RESIDENTIAL",
      "load_types": ["HVAC"],
      "meter_type": "UTILITY_METER",
      "audit": { ... }
    }
  ]
}