List Operating Calendar Closures

Beta

GET/v1/operations/operating-calendars/{id}/closures

This endpoint is idempotent. Learn more

Lists the dates a calendar is shut, within a date window.

Bounded rather than exhaustive: a calendar accumulates closures indefinitely, and the useful answer is the year either side of today. Widen it with from_date and to_date.

Permissions requiredValues:production_schedules:read

The role behind your API key or agent must grant every one of these permissions.

idstring

Operating calendar ID.

from_dateoptional string (date-time)

Earliest closure date to return. Defaults to a year ago.

to_dateoptional string (date-time)

Latest closure date to return. Defaults to a year ahead.

objectstringenumValues:list

Resource type identifier.

page_infoobject

Pagination metadata.

next_page_urlstringnullable

Relative URL that fetches the next page of results.

previous_page_urlstringnullable

Relative URL that fetches the previous page of results.

has_next_pageboolean

Whether more results exist after this page.

has_prev_pageboolean

Whether results exist before this page.

dataarray of operating_calendar_closure

Resources in this page.

objectstringenumValues:operating_calendar_closure

Resource type identifier.

idstring

Unique identifier.

operating_calendar_idstring

The calendar this closure belongs to.

closed_onstring (date-time)

The date nothing operates.

namestring

What the closure is, such as "Thanksgiving Day" or "Summer shutdown".

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for List Operating Calendar Closures

List Operating Calendar Closures

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listOperatingCalendarClosure = await client.operations.operatingCalendars.closures.list(
  'occd_7f2m9qk4wzxb',
);

console.log(listOperatingCalendarClosure.data);

import OpenMRP from '@openmrp/sdk';

const client = new OpenMRP({
  bearerToken: 'YOUR_API_KEY', // Your API key goes here
});

const listOperatingCalendarClosure = await client.operations.operatingCalendars.closures.list(
  'occd_7f2m9qk4wzxb',
);

console.log(listOperatingCalendarClosure.data);

200 example

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": [
    {
      "object": "operating_calendar_closure",
      "id": "occdcn_3vh8yt5nqp1r",
      "operating_calendar_id": "occd_7f2m9qk4wzxb",
      "closed_on": "2026-11-26T00:00:00Z",
      "name": "Thanksgiving Day",
      "created_at": "2026-01-06T09:14:00Z",
      "updated_at": "2026-01-06T09:14:00Z"
    }
  ]
}

{
  "object": "list",
  "page_info": {
    "next_page_url": null,
    "previous_page_url": null,
    "has_next_page": false,
    "has_prev_page": false
  },
  "data": [
    {
      "object": "operating_calendar_closure",
      "id": "occdcn_3vh8yt5nqp1r",
      "operating_calendar_id": "occd_7f2m9qk4wzxb",
      "closed_on": "2026-11-26T00:00:00Z",
      "name": "Thanksgiving Day",
      "created_at": "2026-01-06T09:14:00Z",
      "updated_at": "2026-01-06T09:14:00Z"
    }
  ]
}

List Operating Calendar Closures

Authorization

Path Parameters

Query Parameters

Returns

Responses