Skip to content
/
Retrieve region group

Retrieve region group

Request

Security
oauth2(Required scopes: region:read)
Path
region_group_idstringrgrp[A-Z\d]{26}required
Headers
EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2
curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/region_groups/{region_group_id}' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-Version: 2'

Responses

OK

Headers
EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2
X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000
X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999
Bodyapplication/json
idstringrgrp[A-Z\d]{26}read-only
Example:"rgrp01JCK1HPNAANB8WN253G27SFPC"
urlstring, (uri)read-only
namestring
Example:"Eversource MA Pilot 1A"
regionsArray of strings, (uri)read-only

URLs of the member regions.

regions_collectionstring, (uri)read-only

Pre-built link to the regions collection filtered to this group.

created_atstring, (date-time)read-only
Response
{
  "id": "rgrp01JCK1HPNAANB8WN253G27SFPC",
  "url": "http://example.com",
  "name": "Eversource MA Pilot 1A",
  "regions": [
    "http://example.com"
  ],
  "regions_collection": "http://example.com",
  "created_at": "2019-08-24T14:15:22Z"
}