1. Documentation
2. API

API Endpoints

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.

APIv2 URLs: https://utilityapi.com/api/v2/...

Templates /templates

Templates are the base formatting object for our authorization forms.

• GET /api/v2/templates List or search your templates
• GET /api/v2/templates/123 Get a specific template

Forms /forms

Forms are individual authorization forms that you can send to utility customers.

• GET /api/v2/forms List or search your forms
• POST /api/v2/forms Create a new form
• GET /api/v2/forms/123 Get a specific form
• PATCH /api/v2/forms/123 Modify an existing form
• DELETE /api/v2/forms/123 Delete a form
• POST /api/v2/forms/123/test-submit Simulate a user submitting a form

Authorizations /authorizations

Authorizations are submitted by utility customers.

• GET /api/v2/authorizations List or search your authorizations
• GET /api/v2/authorizations/123 Get a specific authorization
• PATCH /api/v2/authorizations/123 Modify an existing authorization
• DELETE /api/v2/authorizations/123 Delete a authorization (test-submits only)
• POST /api/v2/authorizations/123/revoke Revoke an authorization (deletes all meters and data)

Meters /meters

Meters are the utility services for an authorized utility customer.

• GET /api/v2/meters List or search your meters
• GET /api/v2/meters/123 Get a specific meters
• PATCH /api/v2/meters/123 Modify an existing meters
• POST /api/v2/meters/historical-collection Collect historical billing and interval data for some meters
• POST /api/v2/meters/ongoing-monitoring Start or stop monitoring meters for new bills and intervals

Bills /bills

Bills are the utility bills for an authorized utility customer.

• GET /api/v2/bills List or search your bills

Intervals /intervals

Intervals are the meter usage intervals for an authorized utility customer.

• GET /api/v2/intervals List or search your intervals

Files /files/...

Files are raw or formatted data linked to by other objects in the API.

• GET /api/v2/files/... Get a raw file referenced elsewhere in the API

Events /events

Events are webhook events that are created during authorization and data collection.

• GET /api/v2/events List or search your events
• GET /api/v2/events/123 Get a specific event
• PATCH /api/v2/events/123 Modify an existing event

Accounting Endpoints /accounting

In addition to billing data, we provide accounting data like billing account metadata and payments made to the utility.

Billing Accounts /accounting/billing-accounts

Billing accounts are our representation of the information the utility uses to bill their customers.

• GET /api/v2/accounting/billing-accounts List or search your billing accounts
• GET /api/v2/accounting/billing-accounts/123 Get a specific billing account

Billing Summaries /accounting/billing-summaries

Billing summaries are summaries of payment-related information - usually collected from utility bills.

• GET /api/v2/accounting/billing-summaries List or search your billing summaries
• GET /api/v2/accounting/billing-summaries/123 Get a specific billing summary