CalendarEvents
Get one CalendarEvent
Retrieve a single CalendarEvent record by its Id.
GET
A CalendarEvent represents a physical, virtual, or hybrid event published on the Members Portal. Events can be free or monetised with ticket products.
Physical events can be linked to a space resource via
ResourceId, which automatically blocks that resource from being booked for the event’s duration. Virtual events require the Zoom integration and support both conference calls (IncludeZoomInvite) and webinars (CreateZoomWebinarInvite).
Events support recurring schedules: set RepeatEvent = true on creation and configure Repeats, RepeatEvery, RepeatUntil, and the day-of-week flags. RepeatEvent and all repeat-configuration fields (Repeats, RepeatEvery, RepeatUntil, RepeatOn*) are create-only. Once an event series is created, only WhichEventsToUpdate can be used to update or delete events in the series. New events cannot be added to an existing series.
Attendance can be restricted to all customers, contacts only (OnlyForContacts), or members only (OnlyForMembers). Set Allocation to cap total attendees and enable EnableWaitList to allow overflow sign-ups.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CalendarEvent-Read role.Path Parameters
The Id of the CalendarEvent record to retrieve.
Code Examples
Response
200
The location this event belongs to.
Event name.
Full name of the event host or presenter.
Brief summary shown under the event name on the Members Portal.
Full event description visible when a customer opens the event on the Members Portal.
Additional notes included in ticket confirmation emails.
Allow customers to join a waiting list when the event is at full capacity.
Request the buyer’s postal address during ticket checkout.
Display the attendee list on the Members Portal event page.
Venue or room name displayed on the event page.
Street address of the event venue.
Resource linked to this event; automatically blocked from bookings for the event’s duration.
Event start date and time (UTC).
Event end date and time (UTC).
Maximum number of attendees; leave empty for unlimited.
Categories assigned to this event.
Date and time the event becomes visible on the Members Portal (UTC).
Display this event in the home page banner on the Members Portal.
Display this event on the Members Portal home page.
Allow customers to post comments on the event.
Attach a Zoom conference call link to this event.
Create a Zoom webinar instead of a regular conference call.
Comma-separated email addresses of alternative Zoom hosts who can start the meeting.
Raw Zoom meeting data returned after the Zoom event is created.
Zoom meeting or webinar ID.
Restrict event attendance to contacts only.
Restrict event attendance to members only.
Filename of the small event image shown in related-events sections (read-only; set via
NewSmallLogoUrl).URL of an image to upload as the small event image.
Remove the current small event image.
Filename of the large event image shown on the event list and detail page (read-only; set via
NewLargeLogoUrl).URL of an image to upload as the large event image.
Remove the current large event image.
URL of an external website related to this event.
URL of a Facebook event or page for this event.
URL of an external ticketing page for this event.
Unique identifier shared by all occurrences in a repeat series.
Create this event as a recurring series (create only).
Recurrence pattern for the event series. See
eCalendarEventRepeatCycle enum values: 1 = Daily, 2 = Weekly, 3 = Monthly, 4 = Yearly, 5 = FirstOfMonth, 6 = SecondOfMonth, 7 = ThirdOfMonth, 8 = LastOfMonth, 9 = FourthOfMonth.Which events in the recurring series to update (update only). See
eRepeatedCalendarEventUpdateAction enum values: 1 = UpdateThisEventOnly, 2 = UpdateFutureEventsOnly, 3 = UpdateAllEvents, 4 = DeleteAllEvents, 5 = DeleteEventsAfterThis, 6 = UpdateEventProducts.Number of cycles between occurrences (e.g. 2 with Weekly means every two weeks).
Date the recurring series ends (create only).
Include Mondays in the recurring schedule.
Include Tuesdays in the recurring schedule.
Include Wednesdays in the recurring schedule.
Include Thursdays in the recurring schedule.
Include Fridays in the recurring schedule.
Include Saturdays in the recurring schedule.
Include Sundays in the recurring schedule.
Event start date and time in the location’s local timezone.
Event end date and time in the location’s local timezone.
Publish date and time in the location’s local timezone.
Background job ID for the scheduled post-event notification email.
Send a follow-up notification email to attendees after the event ends.
Custom message body for the post-event notification email.
Send a reminder notification email to attendees before the event starts.
A form is linked to this event that attendees are asked to complete.
Send the linked event form to attendees by email.
ID of the form page linked to this event.
Name of the linked form page.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response