Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Program calendar strategies

List program calendar strategies

List program calendar strategies and their configurations.

<b>Note:</b> This endpoint does not return information about a fixed due date calendar.

get/v1/programs/{programId}/calendar-strategies

Path parameters

programIdinteger required
Example:6912345

Program ID

Query parameters

activeboolean
Example:true

Is the program calendar strategy active?

strategy'FIXED_CYCLE_CLOSING' | 'MONTHLY_CYCLE_CLOSING' | 'MONTHLY_DUE_DATE' | 'WEEKLY_CYCLE_CLOSING' | 'WEEKLY_DUE_DATE' | 'DAILY_CYCLE_CLOSING' | 'DAILY_DUE_DATE'
Example:FIXED_CYCLE_CLOSING

Strategy used to create calendars

pageinteger
Example:1

Page number

perPageinteger
Example:15

Items per page

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

current_pageinteger

Current page number

per_pageinteger

Maximum number of items per page

pagesinteger

Number of pages

total_itemsinteger

Total number of items

Example response

{
  "current_page": 1,
  "per_page": 15,
  "pages": 10,
  "total_items": 100,
  "items": [
    {
      "program_calendar_strategy_id": 67854322,
      "program_id": 1122,
      "created_at": "2024-09-12T16:46:16.43663522",
      "updated_at": "2024-09-12T16:46:16.43663522",
      "configuration": {
        "cycle_closing_day": 10,
        "days_between_cycle_closing_and_due_date": 5
      },
      "active": true
    }
  ]
}