Get one CalendarEvent

GET

api

content

calendarevents

{id}

Get one CalendarEvent

curl --request GET \
  --url https://spaces.nexudus.com/api/content/calendarevents/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/calendarevents/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/calendarevents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "HostFullName": "<string>",
  "ShortDescription": "<string>",
  "LongDescription": "<string>",
  "TicketNotes": "<string>",
  "EnableWaitList": true,
  "AskBuyerAddress": true,
  "ShowEventAttendees": true,
  "Location": "<string>",
  "VenueAddress": "<string>",
  "ResourceId": 123,
  "StartDate": "<string>",
  "EndDate": "<string>",
  "Allocation": 123,
  "EventCategories": [
    123
  ],
  "PublishDate": "<string>",
  "ShowInHomeBanner": true,
  "ShowInHomePage": true,
  "AllowComments": true,
  "IncludeZoomInvite": true,
  "CreateZoomWebinarInvite": true,
  "ZoomWebinarAlternativeHosts": "<string>",
  "ZoomEventData": "<string>",
  "ZoomMeetingId": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "SmallLogoFileName": "<string>",
  "NewSmallLogoUrl": "<string>",
  "ClearSmallLogoFile": true,
  "LargeLogoFileName": "<string>",
  "NewLargeLogoUrl": "<string>",
  "ClearLargeLogoFile": true,
  "WebAddress": "<string>",
  "FacebookPage": "<string>",
  "TicketsPage": "<string>",
  "RepeatSeriesUniqueId": "<string>",
  "RepeatEvent": true,
  "Repeats": 123,
  "WhichEventsToUpdate": 123,
  "RepeatEvery": 123,
  "RepeatUntil": "<string>",
  "RepeatOnMondays": true,
  "RepeatOnTuesdays": true,
  "RepeatOnWednesdays": true,
  "RepeatOnThursdays": true,
  "RepeatOnFridays": true,
  "RepeatOnSaturdays": true,
  "RepeatOnSundays": true,
  "StartDateLocal": "<string>",
  "EndDateLocal": "<string>",
  "PublishDateLocal": "<string>",
  "AfterEventNotificationJobId": "<string>",
  "SendAfterEventNotification": true,
  "AfterEventNotificationText": "<string>",
  "SendBeforeEventNotification": true,
  "HasEventForm": true,
  "SendEventFormByEmail": true,
  "FormPageId": 123,
  "FormPageName": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

integer

required

The Id of the CalendarEvent record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/content/calendarevents/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/calendarevents/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/calendarevents/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

The location this event belongs to.

string

Event name.

string

Full name of the event host or presenter.

string

Brief summary shown under the event name on the Members Portal.

string

Full event description visible when a customer opens the event on the Members Portal.

string

Additional notes included in ticket confirmation emails.

boolean

Allow customers to join a waiting list when the event is at full capacity.

boolean

Request the buyer’s postal address during ticket checkout.

boolean

Display the attendee list on the Members Portal event page.

string

Venue or room name displayed on the event page.

string

Street address of the event venue.

integer

Resource linked to this event; automatically blocked from bookings for the event’s duration.

string

Event start date and time (UTC).

string

Event end date and time (UTC).

integer

Maximum number of attendees; leave empty for unlimited.

integer[]

Categories assigned to this event.

string

Date and time the event becomes visible on the Members Portal (UTC).

boolean

Display this event in the home page banner on the Members Portal.

boolean

Display this event on the Members Portal home page.

boolean

Allow customers to post comments on the event.

boolean

Attach a Zoom conference call link to this event.

boolean

Create a Zoom webinar instead of a regular conference call.

string

Comma-separated email addresses of alternative Zoom hosts who can start the meeting.

string

Raw Zoom meeting data returned after the Zoom event is created.

string

Zoom meeting or webinar ID.

boolean

Restrict event attendance to contacts only.

boolean

Restrict event attendance to members only.

string

Filename of the small event image shown in related-events sections (read-only; set via NewSmallLogoUrl).

string

URL of an image to upload as the small event image.

boolean

Remove the current small event image.

string

Filename of the large event image shown on the event list and detail page (read-only; set via NewLargeLogoUrl).

string

URL of an image to upload as the large event image.

boolean

Remove the current large event image.

string

URL of an external website related to this event.

string

URL of a Facebook event or page for this event.

string

URL of an external ticketing page for this event.

string

Unique identifier shared by all occurrences in a repeat series.

boolean

Create this event as a recurring series (create only).

integer

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.

integer

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.

integer

Number of cycles between occurrences (e.g. 2 with Weekly means every two weeks).

string

Date the recurring series ends (create only).

boolean

Include Mondays in the recurring schedule.

boolean

Include Tuesdays in the recurring schedule.

boolean

Include Wednesdays in the recurring schedule.

boolean

Include Thursdays in the recurring schedule.

boolean

Include Fridays in the recurring schedule.

boolean

Include Saturdays in the recurring schedule.

boolean

Include Sundays in the recurring schedule.

string

Event start date and time in the location’s local timezone.

string

Event end date and time in the location’s local timezone.

string

Publish date and time in the location’s local timezone.

string

Background job ID for the scheduled post-event notification email.

boolean

Send a follow-up notification email to attendees after the event ends.

string

Custom message body for the post-event notification email.

boolean

Send a reminder notification email to attendees before the event starts.

boolean

A form is linked to this event that attendees are asked to complete.

boolean

Send the linked event form to attendees by email.

integer

ID of the form page linked to this event.

string

Name of the linked form page.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "Name": "",
  "HostFullName": null,
  "ShortDescription": null,
  "LongDescription": null,
  "TicketNotes": null,
  "EnableWaitList": false,
  "AskBuyerAddress": false,
  "ShowEventAttendees": false,
  "Location": null,
  "VenueAddress": null,
  "ResourceId": null,
  "StartDate": "2025-01-15T10:30:00Z",
  "EndDate": "2025-01-15T10:30:00Z",
  "Allocation": null,
  "EventCategories": [],
  "PublishDate": null,
  "ShowInHomeBanner": false,
  "ShowInHomePage": false,
  "AllowComments": false,
  "IncludeZoomInvite": false,
  "CreateZoomWebinarInvite": false,
  "ZoomWebinarAlternativeHosts": null,
  "ZoomEventData": null,
  "ZoomMeetingId": null,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "SmallLogoFileName": null,
  "NewSmallLogoUrl": null,
  "ClearSmallLogoFile": null,
  "LargeLogoFileName": null,
  "NewLargeLogoUrl": null,
  "ClearLargeLogoFile": null,
  "WebAddress": null,
  "FacebookPage": null,
  "TicketsPage": null,
  "RepeatSeriesUniqueId": null,
  "RepeatEvent": false,
  "Repeats": 0,
  "WhichEventsToUpdate": 0,
  "RepeatEvery": null,
  "RepeatUntil": null,
  "RepeatOnMondays": false,
  "RepeatOnTuesdays": false,
  "RepeatOnWednesdays": false,
  "RepeatOnThursdays": false,
  "RepeatOnFridays": false,
  "RepeatOnSaturdays": false,
  "RepeatOnSundays": false,
  "StartDateLocal": null,
  "EndDateLocal": null,
  "PublishDateLocal": null,
  "AfterEventNotificationJobId": null,
  "SendAfterEventNotification": false,
  "AfterEventNotificationText": null,
  "SendBeforeEventNotification": false,
  "HasEventForm": false,
  "SendEventFormByEmail": false,
  "FormPageId": null,
  "FormPageName": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CalendarEvent Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CalendarEventsRetrieve multiple CalendarEvent records by their Ids in a single request.

Get one CalendarEvent

curl --request GET \
  --url https://spaces.nexudus.com/api/content/calendarevents/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/content/calendarevents/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/content/calendarevents/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "Name": "<string>",
  "HostFullName": "<string>",
  "ShortDescription": "<string>",
  "LongDescription": "<string>",
  "TicketNotes": "<string>",
  "EnableWaitList": true,
  "AskBuyerAddress": true,
  "ShowEventAttendees": true,
  "Location": "<string>",
  "VenueAddress": "<string>",
  "ResourceId": 123,
  "StartDate": "<string>",
  "EndDate": "<string>",
  "Allocation": 123,
  "EventCategories": [
    123
  ],
  "PublishDate": "<string>",
  "ShowInHomeBanner": true,
  "ShowInHomePage": true,
  "AllowComments": true,
  "IncludeZoomInvite": true,
  "CreateZoomWebinarInvite": true,
  "ZoomWebinarAlternativeHosts": "<string>",
  "ZoomEventData": "<string>",
  "ZoomMeetingId": "<string>",
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "SmallLogoFileName": "<string>",
  "NewSmallLogoUrl": "<string>",
  "ClearSmallLogoFile": true,
  "LargeLogoFileName": "<string>",
  "NewLargeLogoUrl": "<string>",
  "ClearLargeLogoFile": true,
  "WebAddress": "<string>",
  "FacebookPage": "<string>",
  "TicketsPage": "<string>",
  "RepeatSeriesUniqueId": "<string>",
  "RepeatEvent": true,
  "Repeats": 123,
  "WhichEventsToUpdate": 123,
  "RepeatEvery": 123,
  "RepeatUntil": "<string>",
  "RepeatOnMondays": true,
  "RepeatOnTuesdays": true,
  "RepeatOnWednesdays": true,
  "RepeatOnThursdays": true,
  "RepeatOnFridays": true,
  "RepeatOnSaturdays": true,
  "RepeatOnSundays": true,
  "StartDateLocal": "<string>",
  "EndDateLocal": "<string>",
  "PublishDateLocal": "<string>",
  "AfterEventNotificationJobId": "<string>",
  "SendAfterEventNotification": true,
  "AfterEventNotificationText": "<string>",
  "SendBeforeEventNotification": true,
  "HasEventForm": true,
  "SendEventFormByEmail": true,
  "FormPageId": 123,
  "FormPageName": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200