API Reference
Start typing to search…

Search meter enrollments

post
https://api.staging.leap.energy/v2/meters/enrollments/search

Retrieve enrollment information including current enrollment status, participation preferences, associated programs, and any required actions for all meters. Optionally filter by one or more request parameters.

Body Params
string

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.

int32
1 to 500
Defaults to 500

Amount of results to return. Defaults to 500.

string
enum

Defines the transmission region of the meter

Allowed:
string
enum

Whether this is a residential (home) asset or a commercial (business) asset.

Allowed:
meter_ids
array of uuids
length between 0 and 1000

Meter ID

meter_ids
partner_references
array of strings
length between 1 and 1000

Filter meters with a partner reference that is included in this list.

partner_references
global_enrollment_statuses
array of objects
length between 1 and 5

Filter meters with a global_enrollment_status that is included in this list.

meter_types
array of objects
length between 1 and 20

The type of meter

load_types
array of objects
length between 1 and 20

The type of meter

customer_groups
array of strings
length between 1 and 20

The customer group associated with the meter.

customer_groups
tags
array of strings
length between 1 and 20

A tag associated with the meter.

tags
date-time

Find meters that have been modified after this date

date-time

Find meters created after this date

date-time

Find meters created before this date

boolean
Defaults to false

When true, returns only meters that require partner action. False returns all meters.

boolean
Defaults to false

When true, archived meters are excluded in the response. By default they are included.

connection_reference_ids
array of strings
length between 1 and 100

Filter by a set 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.

connection_reference_ids
action_type
array of objects
length between 1 and 20

The type of action required

Responses

Updated 7 months ago

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