For AI agents: visit https://docs.bayou.energy/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Bayou EnergyBayou Energy
DocumentationAPI ReferenceProduct Updates
v2.0

Log InBayou Energy
API Reference
Log In
v2.0DocumentationAPI ReferenceProduct Updates

Bayou Energy API Reference

  • Getting Started With Bayou Energy's API
  • Authentication
  • Customers
    • Create New Customerpost
    • Get List of Customersget
    • Get Customer by IDget
    • Update Customer by IDpatch
  • Bills
    • Upload New Billpost
    • Get Bills by Customer IDget
    • Get Bill by IDget
    • Update Bill by IDpatch
    • Unlock Bill (entirely or partially) by IDpost
  • Rate limits
  • ⚡Utility support
  • External IDs
  • Intervals
    • Get Intervals by Customer IDget
  • Utilities
    • Get List of All Utilities Supported by Bayouget
    • Get a Specific Utility by IDget

Webhooks

  • How to set up webhooks
  • Verifying webhook signatures
  • Available webhooks
    • new_bill
    • updated_bill
    • bills_ready
    • intervals_ready
    • customer_has_filled_credentials
    • new_unparsed_bill
    • customer_must_reauthenticate
Powered by 

Rate limits

To ensure fair use and system stability, our API is rate-limited to 2,000 requests per 5-minute window per user.

If you exceed this limit, requests will be temporarily rejected with a 429 Too Many Requests response.

Updated about 1 year ago


Unlock Bill (entirely or partially) by ID
External IDs
Did this page help you?

Updated about 1 year ago


Unlock Bill (entirely or partially) by ID
External IDs
Did this page help you?