Skip to main content
GET
/
entities
/
site
/
{site_id}
/
eligibility
Get Site Eligibility
curl --request GET \
  --url https://api-sandbox.axle.energy/entities/site/{site_id}/eligibility \
  --header 'Authorization: Bearer <token>'
{
  "site_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "site_properties": {
    "is_half_hourly_settled": false,
    "has_meter_consent": true
  },
  "eligible_propositions": [],
  "assets": []
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

​
site_id
string<uuid>
required

Response

Successful Response

Eligibility detail for a site's proposition eligibility check.

​
site_id
string<uuid>
required
Example:

"a1b2c3d4-e5f6-7890-abcd-ef1234567890"

​
site_properties
Site Properties · object
required

Site-level properties relevant to eligibility evaluation.

Example:
{
  "is_half_hourly_settled": false,
  "has_meter_consent": true
}
​
eligible_propositions
enum<string>[]
Available options:
limited_pause,
full_asset_schedule_control
​
assets
AssetEligibilityDetail · object[]