get
https://api.genability.com/rest/public/calendars/
Return full or filtered calendar definitions for a utility, including holiday, billing, and pricing period calendars.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Use this endpoint to return full or filtered calendar definitions for a utility.
When to use this endpoint
Use GET /rest/public/calendars when you need to:
- Find holiday calendars that affect tariff time-of-use periods.
- Find billing calendars for a specific Load Serving Entity (LSE).
- Find pricing period calendars for dynamic events such as critical peaks or smart days.
- Get the
calendarIdneeded to retrieve one calendar or query calendar dates.
Common filters
| Parameter | Type | Description |
|---|---|---|
lseId | Long | Filters calendars to a specific LSE. Use this when you already know the utility. |
calendarType | String | Filters calendars by type. Supported values are HOLIDAY, BILLING, and PRICING_PERIOD. |
Example request
GET /rest/public/calendars?lseId=734&calendarType=HOLIDAYExample response
{
"status": "success",
"count": 5,
"type": "Calendar",
"results": [
{
"calendarId": 2,
"calendarName": "Holidays",
"calendarType": "HOLIDAY",
"lseId": 734
},
{
"calendarId": 86,
"calendarName": "Holidays",
"calendarType": "HOLIDAY",
"lseId": 734
},
{
"calendarId": 634,
"calendarName": "Holiday-Peaks",
"calendarType": "HOLIDAY",
"lseId": 734
},
{
"calendarId": 646,
"calendarName": "Holidays - Summer",
"calendarType": "HOLIDAY",
"lseId": 734
},
{
"calendarId": 647,
"calendarName": "Holidays - Winter",
"calendarType": "HOLIDAY",
"lseId": 734
}
],
"pageStart": 0,
"pageCount": 25
}