Skip to main content
Applications are the incentive submissions you track through processing. Search and update them, and manage supporting attachments.

​
Base URL and authentication

https://api.incentives.leap.energy/alpha in production, https://api.staging.incentives.leap.energy/alpha in staging. Send your Leap API key in the x-api-key header:

​
Where applications come from

Send create_application: true on Look up incentives and Leap creates one application per eligible program in the background, usually within a few seconds and before the customer opens the Connect URL. Without the flag, Leap creates no applications.

​
Endpoints

Three operations act on the application itself, and five more manage its attachments:
  • Search applications: filter by reference ID or status. Each result’s top-level id is the application ID you pass as application_id everywhere else.
  • Get application: one application in full, with customer and device detail.
  • Update application: supply data on the customer’s behalf. Only the fields you include change; null clears one. Status and system identifiers (id, customer_id, program_id) are read-only.
  • Attachments: upload, list, download, and delete supporting files. See the Requirements reference.

​
Identifiers on this API

Applications, customers, and installations are numbered, so id, customer_id, and the entries in customer_device_id[] are integers. The catalog device_id on a device is not: it’s the same UUID the incentives lookup takes and returns. Read an identifier back from the application rather than constructing one, and the difference stays invisible.

​
Supplying data on the customer’s behalf

When you claim a field under Data Preferences in the portal, Leap removes it from the customer-facing form and expects the value from you. On devices you registered, the customer never sees a claimed field and can’t correct it: if a value turns out to be wrong, send another Update application request. Claimed fields reappear for any device the customer adds themselves.
Claim only the fields you can supply for every customer, and send extras as you get them. Values you submit before the customer opens Connect appear pre-filled for them.