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,
  "ResourceName": "<string>",
  "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>",
  "Tariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An event (CalendarEvent) is 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 bookable resource, which blocks that resource from being booked for the event’s duration. Virtual events use the Zoom integration for conference calls or webinars. Events support recurring series: set RepeatEvent = true on creation with Repeats, RepeatEvery, RepeatUntil, and the day-of-week flags; all repeat-configuration fields are create-only, and WhichEventsToUpdate controls the scope of updates or deletions to an existing series. Attendance can be restricted by customer type (OnlyForContacts, OnlyForMembers), plan, team, or specific customers. Set Allocation to cap total attendees and EnableWaitList to allow overflow sign-ups. Events with registered attendees cannot be deleted.

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

ID of the location this event belongs to..

string

Name of the event displayed on the Members Portal; required..

string

Full name of the person hosting or presenting the event..

string

Short plain-text summary shown under the event name on the Members Portal..

string

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

string

Additional notes appended to ticket confirmation emails..

boolean

Whether customers can join a waiting list when the event is at full capacity..

boolean

Whether to request the buyer’s postal address during ticket checkout..

boolean

Whether the attendee list is displayed on the Members Portal event page..

string

Venue or room name displayed on the event page; changing it notifies registered attendees..

string

Street address of the event venue..

integer

Optional ID of the bookable resource held for this event; it blocks that resource from being booked during the event’s start and end times..

string

Display value for Resource.Name..

string

Event start date and time in UTC; must be before EndDate..

string

Event end date and time in UTC; must be after StartDate..

integer

Maximum total number of attendees for the event; leave empty for unlimited. The effective capacity is the lower of this value and the sum of the ticket products’ allocations..

integer[]

List of category IDs for this event; an empty list means the event has no categories..

string

UTC date and time the event becomes visible on the Members Portal; the system rounds it down to the nearest 15 minutes. Leave empty to keep the event unpublished..

boolean

Whether this event is displayed in the home page banner on the Members Portal..

boolean

Whether this event is displayed on the Members Portal home page..

boolean

Whether customers can post comments on the event..

boolean

Whether the system creates a Zoom conference call for this event and shares the link with attendees..

boolean

Whether to create a Zoom webinar instead of a regular conference call for this event..

string

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

string

Internal raw Zoom meeting payload maintained by the Zoom integration..

string

Internal Zoom meeting or webinar identifier maintained by the Zoom integration..

boolean

Whether only customers without an active contract (contacts) can view and attend this event..

boolean

Whether only customers with an active contract (members) can view and attend this event..

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

Optional URL of an external website related to this event..

string

Optional URL of a Facebook event or page for this event..

string

Optional URL of an external ticketing page for this event..

string

System-generated identifier shared by all occurrences in a recurring series; use it to find and update all events in that series..

boolean

Whether to create this event as a recurring series; only applies when creating the first event in the series..

integer

Recurrence cycle for the series: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth.. See eCalendarEventRepeatCycle enum values: 1 = Daily, 2 = Weekly, 3 = Monthly, 4 = Yearly, 5 = FirstOfMonth, 6 = SecondOfMonth, 7 = ThirdOfMonth, 8 = LastOfMonth, 9 = FourthOfMonth.

integer

For an update to a recurring event, selects the scope: UpdateThisEventOnly, UpdateFutureEventsOnly, UpdateAllEvents, DeleteAllEvents, DeleteEventsAfterThis, or UpdateEventProducts.. See eRepeatedCalendarEventUpdateAction enum values: 1 = UpdateThisEventOnly, 2 = UpdateFutureEventsOnly, 3 = UpdateAllEvents, 4 = DeleteAllEvents, 5 = DeleteEventsAfterThis, 6 = UpdateEventProducts.

integer

Optional positive number of cycles between occurrences; for example, 2 with Weekly repeats every two weeks..

string

Optional final UTC date for creating occurrences in the recurring series; when omitted, occurrences are created for one year..

boolean

Whether the recurring series includes Mondays..

boolean

Whether the recurring series includes Tuesdays..

boolean

Whether the recurring series includes Wednesdays..

boolean

Whether the recurring series includes Thursdays..

boolean

Whether the recurring series includes Fridays..

boolean

Whether the recurring series includes Saturdays..

boolean

Whether the recurring series includes Sundays..

string

System-maintained local-time representation of StartDate; set StartDate (UTC) instead..

string

System-maintained local-time representation of EndDate; set EndDate (UTC) instead..

string

System-maintained local-time representation of PublishDate; set PublishDate (UTC) instead..

string

Internal background job identifier for the scheduled post-event notification email..

boolean

Whether a follow-up notification email is sent to all attendees after the event ends..

string

Custom message body for the post-event notification email..

boolean

Whether a reminder email is sent to attendees within 24 hours before the event starts..

boolean

Whether a form is linked to this event that attendees are asked to complete; the system sets this automatically from FormPage..

boolean

Whether the linked event form is sent to attendees by email, including follow-up reminders..

integer

Optional ID of the form page attendees are asked to complete for this event..

string

Display value for FormPage.Name..

integer[]

List of plan IDs that restrict this event to members subscribed to those plans; an empty list means no plan restriction..

integer[]

List of customer IDs that restrict this event to those specific customers; an empty list means no customer restriction..

integer[]

List of team IDs that restrict this event to customers belonging to those teams; an empty list means no team restriction..

string

Read-only display names of the plans this event is restricted to; change the Tariffs collection instead..

string

Read-only display names of the teams this event is restricted to; change the Teams collection instead..

string

Read-only display names of the customers this event is restricted to; change the Members collection instead..

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,
  "ResourceName": 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,
  "Tariffs": [],
  "Members": [],
  "Teams": [],
  "TariffNames": null,
  "TeamNames": null,
  "CoworkerFullNames": 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 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,
  "ResourceName": "<string>",
  "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>",
  "Tariffs": [
    123
  ],
  "Members": [
    123
  ],
  "Teams": [
    123
  ],
  "TariffNames": "<string>",
  "TeamNames": "<string>",
  "CoworkerFullNames": "<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