Retrieve Operating Calendar

Beta

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

This endpoint is idempotent. Learn more

Retrieves one operating calendar by ID.

Permissions requiredValues:production_schedules:read

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

idstring

Operating calendar ID.

objectstringenumValues:operating_calendar

Resource type identifier.

idstring

Unique identifier.

codestring

Short stable identifier, unique per account.

namestring

Human-readable name.

kindstringenumValues:shipreceive

Which side of a shipment this calendar describes.

days_of_weekstring

Open weekdays as seven characters of '0' or '1', Monday first. "1111100" is Monday to Friday; "1111000" is a Monday-to-Thursday plant.

cutoff_atstringnullable

Local time freight has to be tendered by, as "15:00". Only a shipping calendar carries one.

timezonestringnullable

IANA zone the cutoff is read in. Null on a receiving calendar means it is taken from the ship-to address.

is_defaultboolean

Whether this is the calendar used when nothing more specific is linked. Exactly one per kind.

created_atstring (date-time)

Creation timestamp.

updated_atstring (date-time)

Last updated timestamp.

Responses

200

Successful response for Retrieve Operating Calendar

Retrieve Operating Calendar

import OpenMRP from '@openmrp/sdk';

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

const operatingCalendar = await client.operations.operatingCalendars.retrieve('occd_7f2m9qk4wzxb');

console.log(operatingCalendar.id);

import OpenMRP from '@openmrp/sdk';

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

const operatingCalendar = await client.operations.operatingCalendars.retrieve('occd_7f2m9qk4wzxb');

console.log(operatingCalendar.id);

200 example

{
  "object": "operating_calendar",
  "id": "occd_7f2m9qk4wzxb",
  "code": "default_ship",
  "name": "Shipping days",
  "kind": "ship",
  "days_of_week": "1111000",
  "cutoff_at": "15:00",
  "timezone": "America/Chicago",
  "is_default": true,
  "created_at": "2026-01-06T09:14:00Z",
  "updated_at": "2026-01-06T09:14:00Z"
}

{
  "object": "operating_calendar",
  "id": "occd_7f2m9qk4wzxb",
  "code": "default_ship",
  "name": "Shipping days",
  "kind": "ship",
  "days_of_week": "1111000",
  "cutoff_at": "15:00",
  "timezone": "America/Chicago",
  "is_default": true,
  "created_at": "2026-01-06T09:14:00Z",
  "updated_at": "2026-01-06T09:14:00Z"
}

Retrieve Operating Calendar

Authorization

Path Parameters

Returns

Responses