get
https://api.genability.com/rest/public/calendars/
Return a full or filtered list of Calendars.
Recent Requests
Log in to see full request history
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Loading…
Retrieve calendars that match optional utility, calendar type, and date-range filters.
Use this endpoint to discover calendars before retrieving one calendar by calendarId or retrieving actual calendar dates. Calendars can represent holidays, billing cycles, or dynamic pricing periods.
Resource URI
GET /rest/public/calendars/Query parameters
| Parameter | Type | Description |
|---|---|---|
lseId | Long | Load serving entity ID. Optional. |
calendarType | String | Type of calendar to return. Choices are HOLIDAY, BILLING, and PRICING_PERIOD. Optional. |
fromDateTime | DateTime | Return calendars with dates on or after this date. Optional. |
toDateTime | DateTime | Return calendars with dates on or before this date. Optional. |
For the full calendar data model and examples, see Calendars.
Example
GET /rest/public/calendars?lseId=734&calendarType=HOLIDAYA successful response returns a standard response payload with type set to Calendar and results containing matching calendars.