API Docs / Schemas / ExternalCalendarEventDto

ExternalCalendarEventDto

One concrete occurrence from an external calendar subscription, with recurrences already
expanded and times in practice wall-clock (Europe/London) so they line up with task times.
Wall-clock values are date + time pairs, matching how tasks carry StartDate/StartTime.

Properties

Name Type Description
subscriptionCodestring

Code of the subscription the event came from — join to the subscription list for the
calendar's name and colour.

Code of the subscription the event came from — join to the subscription list for the
calendar's name and colour.

uidstring

The source event's UID plus the occurrence date — stable across fetches.

The source event's UID plus the occurrence date — stable across fetches.

titlestring

The event's summary line.

The event's summary line.

startDatestring

The day the occurrence starts, in practice wall-clock time.

The day the occurrence starts, in practice wall-clock time.

startTimestring

Start time on the start day. Null for all-day events.

Start time on the start day. Null for all-day events.

endDatestring

For an all-day event, the last day it covers (inclusive — a one-day event has
EndDate equal to StartDate). For a timed event, the day it ends on.

For an all-day event, the last day it covers (inclusive — a one-day event has
EndDate equal to StartDate). For a timed event, the day it ends on.

endTimestring

End time on the end day. Null for all-day events; equals StartTime for events with no
stated end.

End time on the end day. Null for all-day events; equals StartTime for events with no
stated end.

isAllDayboolean

Whether this is an all-day (date-only) event.

Whether this is an all-day (date-only) event.

locationstring

The event's location line, when the feed provides one.

The event's location line, when the feed provides one.

meetingUrlstring

Video-call link (Google Meet, Teams, Zoom), when the feed carries one.

Video-call link (Google Meet, Teams, Zoom), when the feed carries one.

descriptionstring

The event's description as plain text, capped server-side. Google Meet's boilerplate
block is stripped — its join link surfaces as MeetingUrl instead.

The event's description as plain text, capped server-side. Google Meet's boilerplate
block is stripped — its join link surfaces as MeetingUrl instead.

JSON Example

{
  "subscriptionCode": "string",
  "uid": "string",
  "title": "string",
  "startDate": "2024-01-01",
  "startTime": "string"
}