Calendar

Read and manage calendar events and attendees.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/calendar/categories
GET /api/calendar/configuration
GET /api/calendar/events
GET /api/calendar/permissions
GET /api/calendar/timezones
GET /api/calendar/{sectionId}/is-subscribed
POST /api/calendar/{sectionId}/subscription/toggle

GET /api/calendar/categories

List categories.

Parameters

Name	In	Type	Required	Description
`sectionId`	query	integer (int32)	Yes

Responses

Status	Body
200	See below
404
500

Response body

[
  {
    "Id": 0,
    "Name": "string",
    "Enabled": true
  }
]

Field	Type
`Id`	integer (int32)
`Name`	string
`Enabled`	boolean

GET /api/calendar/configuration

Get the calendar configuration.

Parameters

Name	In	Type	Required	Description
`sectionId`	query	integer (int32)	Yes

Responses

Status	Body
200	See below
404
500

Response body

{
  "MondayIncluded": true,
  "TuesdayIncluded": true,
  "WednesdayIncluded": true,
  "ThursdayIncluded": true,
  "FridayIncluded": true,
  "SaturdayIncluded": true,
  "SundayIncluded": true,
  "WeekStartDay": 0,
  "EventNoAttendees": true,
  "EventInvitationOnly": true,
  "EventOpenAttendance": true
}

Field	Type
`MondayIncluded`	boolean
`TuesdayIncluded`	boolean
`WednesdayIncluded`	boolean
`ThursdayIncluded`	boolean
`FridayIncluded`	boolean
`SaturdayIncluded`	boolean
`SundayIncluded`	boolean
`WeekStartDay`	integer (int32)
`EventNoAttendees`	boolean
`EventInvitationOnly`	boolean
`EventOpenAttendance`	boolean

GET /api/calendar/events

List events.

Parameters

Name	In	Type	Required
`sectionId`	query	integer (int32)	Yes
`dateFrom`	query	string (date-time)	No
`dateTo`	query	string (date-time)	No
`active`	query	boolean	No
`searchString`	query	string	No

Responses

Status	Body
200	See below
404
500

Response body

[
  {
    "EventId": 0,
    "Title": "string",
    "Summary": "string",
    "Location": "string",
    "Description": "string",
    "Tags": "string",
    "StartDate": "2024-01-01T00:00:00Z",
    "EndDate": "2024-01-01T00:00:00Z",
    "OwnerId": 0,
    "SectionId": 0,
    "AssetId": 0,
    "LetterboxAssetId": 0,
    "ShowTimeToEvent": true,
    "Active": true,
    "InAllCalendars": true,
    "AllDayEvent": true,
    "AttendTypeId": "NoAttendees",
    "Category": "string",
    "MaxNumberOfAttendees": 0,
    "EventSeriesId": 0,
    "IsModifiedEventInSeries": true,
    "IcsRecurrenceId": "2024-01-01T00:00:00Z",
    "TimeZone": "string",
    "IsOwnerHidden": true
  }
]

Field	Type
`EventId`	integer (int32)
`Title`	string
`Summary`	string
`Location`	string
`Description`	string
`Tags`	string
`StartDate`	string (date-time)
`EndDate`	string (date-time)
`OwnerId`	integer (int32)
`SectionId`	integer (int32)
`AssetId`	integer (int32)
`LetterboxAssetId`	integer (int32)
`ShowTimeToEvent`	boolean
`Active`	boolean
`InAllCalendars`	boolean
`AllDayEvent`	boolean
`AttendTypeId`	string
`Category`	string
`MaxNumberOfAttendees`	integer (int32)
`EventSeriesId`	integer (int32)
`IsModifiedEventInSeries`	boolean
`IcsRecurrenceId`	string (date-time)
`TimeZone`	string
`IsOwnerHidden`	boolean

GET /api/calendar/permissions

List permissions.

Parameters

Name	In	Type	Required	Description
`sectionId`	query	integer (int32)	Yes

Responses

Status	Body
200	See below
404
500

Response body

{
  "CanView": true,
  "CanAdd": true,
  "CanDisplayInAllCalendars": true
}

Field	Type
`CanView`	boolean
`CanAdd`	boolean
`CanDisplayInAllCalendars`	boolean

GET /api/calendar/timezones

List timezones.

Responses

Status	Body
200	See below
500

Response body

[
  {
    "DisplayName": "string",
    "Id": "string",
    "SupportsDaylightSavingTime": true
  }
]

Field	Type
`DisplayName`	string
`Id`	string
`SupportsDaylightSavingTime`	boolean

GET /api/calendar/{sectionId}/is-subscribed

Check whether the person is subscribed.

Parameters

Name	In	Type	Required	Description
`sectionId`	path	integer (int32)	Yes

Responses

Status	Body
200	boolean
500

POST /api/calendar/{sectionId}/subscription/toggle

Create a toggle.

Parameters

Name	In	Type	Required	Description
`sectionId`	path	integer (int32)	Yes

Responses

Status	Body
200	boolean
500

Section: REST API