Subscribe to a calendar

GET

/calendars/sync/{calendarExportLink}

const url = 'https://calendar.work.optidata.cloud/api/calendars/sync/b7f3c1a29e5d4f08a1c6d2b4e8f70931';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://calendar.work.optidata.cloud/api/calendars/sync/b7f3c1a29e5d4f08a1c6d2b4e8f70931

Streams a calendar as an iCalendar (.ics) feed, for external calendar applications that subscribe to a URL and re-read it periodically.

Authentication is the token in the path, not the authentication key: the URL alone grants read access to the calendar, so treat it as a secret and revoke it in Optiwork when it is no longer needed. A revoked or expired token stops resolving.

The feed is read-only. Nothing an external application changes in its local copy travels back.

A token that no longer resolves is currently answered with a 500 HTML page rather than the 404 this endpoint is meant to return. Treat any non-200 answer as “this subscription is gone”; the response will become a proper 404 once the defect is fixed.

Parameters

Path Parameters

calendarExportLink

required

string

The subscription token. Generate it for a calendar in Optiwork; it can be revoked there at any time.

Responses

200

The calendar as an iCalendar document.

text/calendar

string

Examples

feed

BEGIN:VCALENDAR
VERSION:2.0
PRODID:-//Optidata//Optiwork Calendar//EN
BEGIN:VEVENT
UID:de373eee-9440-4420-a53b-1be5ccd4eb18
DTSTART:20260824T170000Z
DTEND:20260824T180000Z
SUMMARY:Sprint review
LOCATION:Meeting room 2
END:VEVENT
END:VCALENDAR

404

The intended answer when the token is unknown, revoked or expired. Not yet what the service returns — see the 500 below.

500

What an unknown, revoked or expired token answers today: an HTML error page instead of the 404 above. Documented because it is the live behaviour, not a contract to rely on.

text/html

string