HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Get One Incentive API

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retrieve one solar incentive by incentiveId.

Use this endpoint when you already have an incentive ID from Get Solar Incentives and need the full incentive record, including optional applicabilities or source documents.

triangle-exclamation

Solar incentive data requires special permissions and is available only under specific circumstances for Enterprise customers using Switch.

Resource URI

GET /rest/v1/incentives/{incentiveId}

Path parameters

ParameterTypeDescription
incentiveIdStringArcadia ID for the incentive. Required.

Query parameters

ParameterTypeDescription
populateDetailsBooleanWhen true, includes applicability details. Optional.
populateDocumentsBooleanWhen true, includes links to relevant incentive documents. Optional.

For the full incentive data model and detailed examples, see Solar Incentives.

Example

GET /rest/v1/incentives/3163702?populateDetails=true

A successful response returns a standard response payload with type set to Incentive and one incentive in the results array.

Path Params
string
required

Arcadia ID for an incentive

Query Params
boolean

Whether to include the applicabilities or not.

boolean

Whether to return link(s) to the relevant document(s)

Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json