Get Calendar by ID

Time	Status	User Agent
Retrieving recent requests…

Use this endpoint to retrieve one calendar and the event definitions attached to it.

When to use this endpoint

Use GET /rest/public/calendars/{calendarId} when you need to:

Inspect the events defined on a known calendar.
Confirm whether a calendar represents holidays, billing periods, or pricing periods.
Review event metadata before querying the actual calendar dates.
Filter the calendar's events by a date range.

Required input

Parameter	Type	Description
`calendarId`	Long	The unique ID of the calendar to retrieve. You can get this value from Get Calendars.

Optional filters

Parameter	Type	Description
`fromDateTime`	DateTime	Returns events on or after this date.
`toDateTime`	DateTime	Returns events on or before this date.

Example request

GET /rest/public/calendars/2

Example response

{
  "status": "success",
  "count": 1,
  "type": "Calendar",
  "results": [
    {
      "calendarId": 2,
      "calendarName": "Holidays",
      "calendarType": "HOLIDAY",
      "lseId": 734,
      "events": [
        {
          "calendarEventId": 2,
          "calendarEventName": "New Year's Day",
          "lseId": null,
          "calendarEventType": "HOLIDAY",
          "locale": "US",
          "seededUntil": "2017-01-01"
        }
      ]
    }
  ]
}