Calendar

Base URL: $BUSINESS_API

The object

idstring · optional
tenant_idstring · optional
source_idstring · optional
formatstring · optional

one of ics, csv

statusstring · optional

one of preview, applied, failed

itemsarray of CalendarImportItem · optional
Show child attributes
kindstring · optional
uidstring · optional
datestring (date) · optional
monthinteger · optional
dayinteger · optional
weekdayinteger · optional
positioninteger · optional
easter_kindstring · optional

one of western, orthodox

easter_offsetinteger · optional
observedstring · optional

one of none, next, previous, nearest

valid_fromstring (date) · optional
valid_tostring (date) · optional
name_ptstring · optional
name_enstring · optional
kind_of_daystring · optional

one of holiday, closure, working

area_idstring · optional
source_refstring · optional
addedarray of CalendarImportItem · optional
Show child attributes
kindstring · optional
uidstring · optional
datestring (date) · optional
monthinteger · optional
dayinteger · optional
weekdayinteger · optional
positioninteger · optional
easter_kindstring · optional

one of western, orthodox

easter_offsetinteger · optional
observedstring · optional

one of none, next, previous, nearest

valid_fromstring (date) · optional
valid_tostring (date) · optional
name_ptstring · optional
name_enstring · optional
kind_of_daystring · optional

one of holiday, closure, working

area_idstring · optional
source_refstring · optional
changedarray of CalendarImportItem · optional
Show child attributes
kindstring · optional
uidstring · optional
datestring (date) · optional
monthinteger · optional
dayinteger · optional
weekdayinteger · optional
positioninteger · optional
easter_kindstring · optional

one of western, orthodox

easter_offsetinteger · optional
observedstring · optional

one of none, next, previous, nearest

valid_fromstring (date) · optional
valid_tostring (date) · optional
name_ptstring · optional
name_enstring · optional
kind_of_daystring · optional

one of holiday, closure, working

area_idstring · optional
source_refstring · optional
removedarray of CalendarImportItem · optional
Show child attributes
kindstring · optional
uidstring · optional
datestring (date) · optional
monthinteger · optional
dayinteger · optional
weekdayinteger · optional
positioninteger · optional
easter_kindstring · optional

one of western, orthodox

easter_offsetinteger · optional
observedstring · optional

one of none, next, previous, nearest

valid_fromstring (date) · optional
valid_tostring (date) · optional
name_ptstring · optional
name_enstring · optional
kind_of_daystring · optional

one of holiday, closure, working

area_idstring · optional
source_refstring · optional
conflictsarray of object · optional
Show child attributes
datestring (date) · optional
existing_kindstring · optional

one of holiday, closure, working

incoming_kindstring · optional

one of holiday, closure, working

detailstring · optional
affectedarray of object · optional
Show child attributes
typestring · required
idstring · required
namestring · optional
fromstring (date-time) · optional
tostring (date-time) · optional
countinteger · required
affected_limitationsarray of string · optional

Consumer coverage gaps and date behaviors not recalculated by this preview.

confirmed_bystring · optional
outcomestring · optional
created_atstring (date-time) · optional
applied_atstring (date-time) · optional
The object
{
  "id": "cal_26gTtQiVPucb3CyVJaoRD6UlbOQ",
  "tenant_id": "ten_2ugFXIC316WXzGu1HGal90AxTA6",
  "source_id": "sou_2fjWEpPCsLRCQBV64hz26xd8MF9",
  "format": "ics",
  "status": "preview",
  "items": [
    {
      "kind": "active",
      "uid": "uid",
      "date": "2026-11-19",
      "month": 1,
      "day": 1,
      "weekday": 1,
      "position": 1,
      "easter_kind": "western",
      "easter_offset": 1,
      "observed": "none",
      "valid_from": "2026-11-19",
      "valid_to": "2026-11-19",
      "name_pt": "name pt",
      "name_en": "name en",
      "kind_of_day": "holiday",
      "area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
      "source_ref": "source ref"
    }
  ],
  "added": [
    {
      "kind": "active",
      "uid": "uid",
      "date": "2026-11-19",
      "month": 1,
      "day": 1,
      "weekday": 1,
      "position": 1,
      "easter_kind": "western",
      "easter_offset": 1,
      "observed": "none",
      "valid_from": "2026-11-19",
      "valid_to": "2026-11-19",
      "name_pt": "name pt",
      "name_en": "name en",
      "kind_of_day": "holiday",
      "area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
      "source_ref": "source ref"
    }
  ],
  "changed": [
    {
      "kind": "active",
      "uid": "uid",
      "date": "2026-11-19",
      "month": 1,
      "day": 1,
      "weekday": 1,
      "position": 1,
      "easter_kind": "western",
      "easter_offset": 1,
      "observed": "none",
      "valid_from": "2026-11-19",
      "valid_to": "2026-11-19",
      "name_pt": "name pt",
      "name_en": "name en",
      "kind_of_day": "holiday",
      "area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
      "source_ref": "source ref"
    }
  ],
  "removed": [
    {
      "kind": "active",
      "uid": "uid",
      "date": "2026-11-19",
      "month": 1,
      "day": 1,
      "weekday": 1,
      "position": 1,
      "easter_kind": "western",
      "easter_offset": 1,
      "observed": "none",
      "valid_from": "2026-11-19",
      "valid_to": "2026-11-19",
      "name_pt": "name pt",
      "name_en": "name en",
      "kind_of_day": "holiday",
      "area_id": "are_2ZTQYjrK63ZImD3sMz1O2BhWeZV",
      "source_ref": "source ref"
    }
  ],
  "conflicts": [
    {
      "date": "2026-11-19",
      "existing_kind": "holiday",
      "incoming_kind": "holiday",
      "detail": "detail"
    }
  ],
  "affected": [
    {
      "type": "active",
      "id": "cal_26gTtQiVPucb3CyVJaoRD6UlbOQ",
      "name": "Ana Matsinhe",
      "from": "2026-11-19T09:30:00Z",
      "to": "2026-11-19T09:30:00Z",
      "count": 1
    }
  ],
  "affected_limitations": [
    "affected limitation"
  ],
  "confirmed_by": "confirmed by",
  "outcome": "outcome",
  "created_at": "2026-11-19T09:30:00Z",
  "applied_at": "2026-11-19T09:30:00Z"
}