Get meter enrollment
| Time | Status | User Agent | |
|---|---|---|---|
| Make a request to see history. |
URL Expired
The URL for this request expired after 30 days.
meter_id
uuid
required
Meter ID
``200 Successful response with meter information.
object
meter_id
uuid
required
The unique identifier for the meter.
partner_reference
string
length between 3 and 256
^[^\/\\?\]\[{}!#$%^&*()<>|]{3,256}$
The partner-supplied reference ID to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.
transmission_region
string
enum
required
Defines the transmission region of the meter
CAISO``ERCOT``NYISO``ISONE``PJM``SERC``WECC_SW``WECC_PC
customer_classification
string
enum
Whether this is a residential (home) asset or a commercial (business) asset.
RESIDENTIAL``COMMERCIAL
load_types
array of objects
required
length ≥ 1
The partner-controlled and curtailable assets associated with the meter. Multiple load types per meter are supported.
The load type of the device
HVAC``EV_CHARGING``BATTERY_STORAGE``COLD_STORAGE``PUMPING``WATER_HEATING``BUILDING_AUTOMATION``GENERATION``MANUFACTURING``LIGHTING``OTHER
meter_type
string
enum
The type of asset.
UTILITY_METER``SUBMETER``DEVICE
connection_references
array of strings
List of connection reference IDs, which are the refIDs supplied during completed Leap Connect authorizations. A meter may have multiple connection reference IDs if multiple people authorized the same meter or a single person authorized a meter multiple times with different reference IDs each time.
The partner-supplied reference ID to help identify the customer or site that a Leap meter correlates to a partner’s internal systems.
customer_group
string
^[’'+#"@()/&.,;A-Za-z\u00C0-\u024F\u1E00-\u1EFF0-9\s_\-]{0,128}$
The customer group associated with the meter.
tags
array of strings
required
Tags set by partner or Leap to help group and identify meters
is_archived
boolean
required
Whether the meter is archived
audt
object
required
created_by
string
enum
Which entity created the meter
PARTNER``LEAP``UTILITY
created_at
date-time
When the meter was created
updated_at
date-time
When the meter was last updated
global_enrollment_status
string
enum
required
The enrollment status of the meter.
ACTIVE``ELIGIBLE``INELIGIBLE``NOT_PARTICIPATING``PENDING
participation_preferences
array of objects
Details about the participation preferences.
participation_preferences
object
participation_preference
string
enum
required
PARTICIPATE``IDLE``DISENROLL
start_time
date-time
required
The start time of the idle period in UTC.
end_time
date-time
The end time of the idle period in UTC.
reason
string
The reason for the idle period.
program_enrollment
array of objects
required
List of enrollments.
program_enrollment*
object
program_identifier
string
enum
Identifier of program
CAISO-CCA-SC_ONLY``CCA``CEC-DSGS-OPTION4``CEC-DSGS``CONED-CSRP``CONED-DLRP``DRAM``ELRP``ENERGY-ONLY``ERCOT-ERS``EVERSOURCE-CS``MA_DOER-CPS``NATGRID-CS``NRG-REALTIME``NRG-RED``NYISO-SCR``ONCOR-CLM``PGE-ART``PGE-CBP``PJM-CAPACITY``PSEGLI-CSRP``PSEGLI-DLRP``RIE-CS``UNITIL-CS``PSE-RPO``SRP-RPO``TVA-RPO``CAISO-ELRP-A4``CEC-DSGS-OPTION2
delivery_period
string
The delivery period of the program. delivery_period_start_date_time date-time
required
The start date and time of the program in UTC. delivery_period_end_date_time date-time
required
The end date and time of the program in UTC. enrollment_status
string
enum
required
The enrollment status of the meter.
ACTIVE``ELIGIBLE``INELIGIBLE``NOT_PARTICIPATING``PENDING
enrollment_deadlines
array of objects
required
full list of enrollment deadlines with the expected activation dates for the delivery period
enrollment_deadlines*
object
enrollment_deadline_date_time date-time
required
The deadline to complete all meter actions for a meter to be enrolled on the activation date
activation_date_time date-time
required
The date a meter is expected to be activated when it is Eligible on the Enrollment Deadline
market_group_id
uuid
The market group ID associated with the program.
market_group_name
string
Name for the market group
required_actions
object
required
partner
array of objects
Required actions for the partner
partner
object
program_identifier
string
enum
Identifier of program
CAISO-CCA-SC_ONLY``CCA``CEC-DSGS-OPTION4``CEC-DSGS``CONED-CSRP``CONED-DLRP``DRAM``ELRP``ENERGY-ONLY``ERCOT-ERS``EVERSOURCE-CS``MA_DOER-CPS``NATGRID-CS``NRG-REALTIME``NRG-RED``NYISO-SCR``ONCOR-CLM``PGE-ART``PGE-CBP``PJM-CAPACITY``PSEGLI-CSRP``PSEGLI-DLRP``RIE-CS``UNITIL-CS``PSE-RPO``SRP-RPO``TVA-RPO``CAISO-ELRP-A4``CEC-DSGS-OPTION2
delivery_period
string
The delivery period of the program. enrollment_deadline_date_time date-time
required
The deadline date and time for the required action in UTC. action_type
string
enum
required
The type of action required to participate with this meter.
IS_AUTHORIZED``DOCUMENTS_SIGNED``HAS_AMI``NOT_ENROLLED_IN_CONFLICTING_PROGRAM``PARTICIPATING``HAS_MARKET_REGISTRATION``NO_MISSING_FIELDS``GENERATOR``ADDRESS``HAS_NOMINATIONS``HAS_BIDDING_STRATEGY``IS_ELIGIBLE``IS_ASSIGNED_TO_A_RESOURCE``MEETS_EXTRA_PROGRAM_REQUIREMENTS
action_description
string
required
Description of the required action. action_code
string
required
The action code.
leap
array of objects
Required actions for Leap
leap
object
program_identifier
string
enum
Identifier of program
string
The delivery period of the program. enrollment_deadline_date_time date-time
required
The deadline date and time for the required action in UTC. action_type
string
enum
required
The type of action required to participate with this meter.
string
required
Description of the required action. action_code
string
required
The action code.
``400 The request is not valid
``401 You are not authorized to perform this operation.
``403 You do not have the necessary permissions for this operation.
``404 Meter not found
``500 Internal server error
Base URL
https://api.staging.leap.energy/v2/meters/{meter_id}/enrollments
xxxxxxxxxx
curl --request GET \
--url https://api.staging.leap.energy/v2/meters/meter_id/enrollments \
--header 'accept: application/json'
xxxxxxxxxx
{
"meter_id": "1fa85f64-5717-4562-b3fc-2c963f66afa6",
"partner_reference": "unique-reference-id-12345",
"transmission_region": "CAISO",
"customer_classification": "RESIDENTIAL",
"load_types": [\
\
"HVAC"\
\
],
"meter_type": "UTILITY_METER",
"connection_references": [\
\
"string"\
\
],
"customer_group": "string",
"tags": [\
\
"tag1",\
\
"tag2"\
\
],
"is_archived": true,
"audit": {
"created_by": "PARTNER",
"created_at": "2022-10-01T08:31:53.956Z",
"updated_at": "2024-10-12T08:31:53.956Z"
},
"global_enrollment_status": "ACTIVE",
"participation_preferences": [\
\
{\
\
"participation_preference": "PARTICIPATE",\
\
"start_time": "2024-11-01T00:00:00Z",\
\
"end_time": "9000-01-01T00:00:00Z"\
\
}\
\
],
"program_enrollment": [\
\
{\
\
"program_identifier": "CEC-DSGS",\
\
"delivery_period": "CEC-DSGS_2025_AUG_OCT",\
\
"delivery_period_start_date_time": "2024-10-01T08:31:53.956Z",\
\
"delivery_period_end_date_time": "2024-12-01T08:31:53.956Z",\
\
"enrollment_status": "ACTIVE",\
\
"enrollment_deadlines": [\
\
{\
\
"enrollment_deadline_date_time": "2024-09-15T00:00:00.000Z",\
\
"activation_date_time": "2024-10-01T00:00:00.000Z"\
\
},\
\
{\
\
"enrollment_deadline_date_time": "2024-10-15T00:00:00.000Z",\
\
"activation_date_time": "2024-11-01T00:00:00.000Z"\
\
}\
\
],\
\
"market_group_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",\
\
"market_group_name": "GRP1_NAME"\
\
}\
\
],
"required_actions": {
"partner": [],
"leap": []
}
}