Calendar events API

Before you start

• You need an API key and secret created in Control Panel > Security, used to obtain a bearer token. See Authentication overview.
• Every request must send the Authorization: Bearer {{access_token}} and X-Tenant: {{tenant_id}} headers.
• To create, update or delete an event you must act as a user with author rights on the target section. Calendar events belong to a section, so the authenticated user's permissions on that section apply.

Note: All examples use the base URL {{api_domain}}/api. Replace {{api_domain}} with your intranet API domain and the {{snake_case}} placeholders with your own values.

Overview

The API exposes two related resources:

• Calendar events (/calendar-event) — a single, one-off event.
• Calendar event series (/calendar-event-series) — a recurring event defined by recurrence settings (for example, every Tuesday). A series has the same sub-resources as a single event, plus create and update operations that accept recurrence rules.

Both resources share the same sub-resources for attendees, RSVPs (responses) and iCal export, so once you know one set you know the other. Identifiers in paths are integers.

Important: The /api/event/{{event_id}} endpoints are a legacy version retained for backward compatibility. Use /api/calendar-event/... for new integrations. See Deprecated endpoints.

Calendar event endpoints

Get a calendar event

GET {{api_domain}}/api/calendar-event/{{event_id}}

Returns the event object (the same fields you supply when creating an event — see Event object fields).

List calendar events

GET {{api_domain}}/api/calendar-event/list?sectionId={{section_id}}

Create a calendar event

POST {{api_domain}}/api/calendar-event
Content-Type: application/json

{
  "StartDate": "2026-06-06T07:38:18.503Z",
  "EndDate": "2026-06-06T08:38:18.503Z",
  "TimeZone": "GMT Standard Time",
  "AllDayEvent": true,
  "SectionID": 11436,
  "OwnerID": 1344,
  "Title": "Quarterly all-hands",
  "AssetID": 0,
  "Summary": "",
  "Tags": "API",
  "Location": "",
  "Active": true,
  "InAllCalendars": false,
  "AttendType": "OpenAttendance",
  "Category": "0",
  "MaxNumberOfAttendees": 0,
  "Description": "Some content goes here"
}

See Event object fields for the meaning of each field.

Delete a calendar event

DELETE {{api_domain}}/api/calendar-event/{{event_id}}

Export an event as iCal

GET {{api_domain}}/api/calendar-event/{{event_id}}/ical

Returns an iCal (.ics) representation suitable for importing into external calendar clients.

Attendees and RSVPs

GET {{api_domain}}/api/calendar-event/{{event_id}}/attendees
GET {{api_domain}}/api/calendar-event/{{event_id}}/responses/{{response}}
GET {{api_domain}}/api/calendar-event/{{event_id}}/response-counts

• attendees lists everyone attending.
• responses/{{response}} lists people who gave a specific RSVP, where {{response}} is one of yes, no or maybe.
• response-counts returns the totals for each response type.

Respond to an event

POST {{api_domain}}/api/calendar-event/{{event_id}}/respond?response={{response}}

This endpoint takes no request body.

Invite users to an event

POST {{api_domain}}/api/calendar-event/{{event_id}}/invite
Content-Type: application/json

{
  "Message": "Please join our event!",
  "Invitations": [
    {
      "ID": 280,
      "IsPerson": true
    }
  ]
}

Event series endpoints

A series uses the same sub-resources as a single event. The differences are that create and update accept recurrence settings, and update requires a confirmRegeneration flag.

Create an event series

POST {{api_domain}}/api/calendar-event-series
Content-Type: application/json

{
  "SeriesStartDate": "2026-05-29T07:38:18.521Z",
  "EventStartDate": "2026-05-29T07:38:18.521Z",
  "EventEndDate": "2026-05-29T08:38:18.521Z",
  "TimeZone": "GMT Standard Time",
  "AllDayEvent": false,
  "RecurrenceSettings": {
    "Type": {
      "Mode": "Weekly",
      "TypeSettings": {
        "WeeklySelectedDays": ["Tuesday"],
        "WeeklyFreq": "1"
      }
    },
    "Ends": {
      "Type": "EndBy",
      "NumberOfOccurrences": 0,
      "EndDate": "2026-08-31T00:00:00.000Z"
    }
  },
  "SectionID": 11436,
  "OwnerID": 1344,
  "Title": "Weekly stand-up",
  "AssetID": 0,
  "Summary": "",
  "Tags": "API"
}

Update an event series

PUT {{api_domain}}/api/calendar-event-series/{{series_id}}?confirmRegeneration=true
Content-Type: application/json

The body matches the create body. The Type.Mode value (for example Daily or Weekly) determines which TypeSettings apply.

Warning: Updating recurrence settings can regenerate the events in a series, which may remove existing events and their RSVPs. Set confirmRegeneration=true only when you intend this.

Reference

Event object fields

Series add the recurrence fields: SeriesStartDate, EventStartDate, EventEndDate and RecurrenceSettings.

Attendance types

Note: OpenAttendance (anyone with access can attend) is the confirmed value. Other attendance modes may exist for invite-only or approval-required events; verify the exact value against your intranet before relying on it.

Response (RSVP) values

Yes, No, Maybe. The respond endpoints accept these as the response query value; the responses/{{response}} listing uses the lower-case form (yes, no, maybe).

Recurrence settings

Deprecated endpoints

Note: For response body schemas, see the calendar endpoints under Events & calendar in the API reference. The request methods, paths, parameters and bodies on this page were verified against the API.

Related

• Authentication overview
• REST API