Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
List calendars

List calendars

List calendars for a program.

You can use the following fields to filter the results. At most one of these fields should be filled.

  • dueDay
  • programCalendarStrategyId
  • divisionId
get/v1/programs/{programId}/calendars

Path parameters

programIdinteger required
Example:6912345

Program ID

Query parameters

dueDayinteger
Example:15

Due day of the calendar

programDueDateIdinteger
Example:123

Program due date ID

programCalendarStrategyIdinteger
Example:5

Program calendar strategy ID

includeDivisionCalendarsboolean
Example:true

Include division calendars?

divisionIdinteger
Example:10

Division ID

perPageinteger
Example:15

Items per page

nextCursorinteger
Example:30

Cursor for pagination

Headers

x-cidstring
Example:5bb05174-4e80-11ea-b77f-2e728ce88125

The Correlation Identifier field is used to link related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. You can find the x-cid field in the response header of an API endpoint call. If the x-cid value isn't passed, one is automatically generated.

Response

OK

has_nextboolean

Is there is a next page?

next_cursorinteger

Cursor for the next page

Example response

{
  "has_next": true,
  "calendars": [
    {
      "calendar_id": 57868,
      "cycle_closing_date": "2021-05-24",
      "due_date": "2021-05-24",
      "real_due_date": "2024-09-18",
      "program_due_date_id": 1,
      "program_calendar_strategy_id": 5,
      "division_id": 10
    }
  ]
}