UtilityAPI, version 2, is easy! Below are brief descriptions of our API endpoints. If you're not clear on how to use these endpoints, head over to the Quickstart to get a brief introduction to using UtilityAPI.
Templates are the base formatting object for our authorization forms.
/api/v2/templatesList or search your templates
/api/v2/templates/123Get a specific template
Forms are individual authorization forms that you can send to utility customers.
/api/v2/formsList or search your forms
/api/v2/formsCreate a new form
/api/v2/forms/123Get a specific form
/api/v2/forms/123Modify an existing form
/api/v2/forms/123Delete a form
/api/v2/forms/123/test-submitSimulate a user submitting a form
Authorizations are submitted by utility customers.
/api/v2/authorizationsList or search your authorizations
/api/v2/authorizations/123Get a specific authorization
/api/v2/authorizations/123Modify an existing authorization
/api/v2/authorizations/123Delete a authorization (test-submits only)
/api/v2/authorizations/123/revokeRevoke an authorization (deletes all meters and data)
Meters are the utility services for an authorized utility customer.
/api/v2/metersList or search your meters
/api/v2/meters/123Get a specific meters
/api/v2/meters/123Modify an existing meters
/api/v2/meters/historical-collectionCollect historical billing and interval data for some meters
/api/v2/meters/ongoing-monitoringStart or stop monitoring meters for new bills and intervals
Bills are the utility bills for an authorized utility customer.
/api/v2/billsList or search your bills
Intervals are the meter usage intervals for an authorized utility customer.
/api/v2/intervalsList or search your intervals
Files are raw or formatted data linked to by other objects in the API.
/api/v2/files/...Get a raw file referenced elsewhere in the API
Events are webhook events that are created during authorization and data collection.