Search CalendarEvents - Nexudus Platform

GET

api

content

calendarevents

Search CalendarEvents

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Enums

eCalendarEventRepeatCycle — Repeats values

Value	Name
1	Daily
2	Weekly
3	Monthly
4	Yearly
5	FirstOfMonth
6	SecondOfMonth
7	ThirdOfMonth
8	LastOfMonth
9	FourthOfMonth

eRepeatedCalendarEventUpdateAction — WhichEventsToUpdate values

Value	Name
1	UpdateThisEventOnly
2	UpdateFutureEventsOnly
3	UpdateAllEvents
4	DeleteAllEvents
5	DeleteEventsAfterThis
6	UpdateEventProducts

Query Parameters

Pagination & Sorting

page

integer

default:"1"

The page number to retrieve.

size

integer

default:"25"

The number of records per page.

orderBy

string

The property name to sort results by (e.g. Name, CreatedOn).

dir

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CalendarEvent_Business

integer

Filter by the location this event belongs to.

CalendarEvent_Name

string

Filter by event name.

CalendarEvent_HostFullName

string

Filter by full name of the event host or presenter.

CalendarEvent_ShortDescription

string

Filter by brief summary shown under the event name on the Members Portal.

CalendarEvent_LongDescription

string

Filter by full event description visible when a customer opens the event on the Members Portal.

CalendarEvent_TicketNotes

string

Filter by additional notes included in ticket confirmation emails.

CalendarEvent_EnableWaitList

boolean

Filter by allow customers to join a waiting list when the event is at full capacity.

CalendarEvent_AskBuyerAddress

boolean

Filter by request the buyer’s postal address during ticket checkout.

CalendarEvent_ShowEventAttendees

boolean

Filter by display the attendee list on the Members Portal event page.

CalendarEvent_Location

string

Filter by venue or room name displayed on the event page.

CalendarEvent_VenueAddress

string

Filter by street address of the event venue.

CalendarEvent_Resource

integer

Filter by resource linked to this event; automatically blocked from bookings for the event’s duration.

CalendarEvent_StartDate

string

Filter by event start date and time (UTC).

CalendarEvent_EndDate

string

Filter by event end date and time (UTC).

CalendarEvent_Allocation

integer

Filter by maximum number of attendees; leave empty for unlimited.

CalendarEvent_PublishDate

string

Filter by date and time the event becomes visible on the Members Portal (UTC).

CalendarEvent_ShowInHomeBanner

boolean

Filter by display this event in the home page banner on the Members Portal.

CalendarEvent_ShowInHomePage

boolean

Filter by display this event on the Members Portal home page.

CalendarEvent_AllowComments

boolean

Filter by allow customers to post comments on the event.

CalendarEvent_IncludeZoomInvite

boolean

Filter by attach a Zoom conference call link to this event.

CalendarEvent_CreateZoomWebinarInvite

boolean

Filter by create a Zoom webinar instead of a regular conference call.

CalendarEvent_ZoomWebinarAlternativeHosts

string

Filter by comma-separated email addresses of alternative Zoom hosts who can start the meeting.

CalendarEvent_ZoomEventData

string

Filter by raw Zoom meeting data returned after the Zoom event is created.

CalendarEvent_ZoomMeetingId

string

Filter by zoom meeting or webinar ID.

CalendarEvent_OnlyForContacts

boolean

Filter by restrict event attendance to contacts only.

CalendarEvent_OnlyForMembers

boolean

Filter by restrict event attendance to members only.

CalendarEvent_SmallLogoFileName

string

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

CalendarEvent_NewSmallLogoUrl

string

Filter by uRL of an image to upload as the small event image.

CalendarEvent_ClearSmallLogo

boolean

Filter by remove the current small event image.

CalendarEvent_LargeLogoFileName

string

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

CalendarEvent_NewLargeLogoUrl

string

Filter by uRL of an image to upload as the large event image.

CalendarEvent_ClearLargeLogo

boolean

Filter by remove the current large event image.

CalendarEvent_WebAddress

string

Filter by uRL of an external website related to this event.

CalendarEvent_FacebookPage

string

Filter by uRL of a Facebook event or page for this event.

CalendarEvent_TicketsPage

string

Filter by uRL of an external ticketing page for this event.

CalendarEvent_RepeatSeriesUniqueId

string

Filter by unique identifier shared by all occurrences in a repeat series.

CalendarEvent_RepeatEvent

boolean

Filter by create this event as a recurring series (create only).

CalendarEvent_Repeats

integer

Filter by recurrence pattern for the event series.

CalendarEvent_WhichEventsToUpdate

integer

Filter by which events in the recurring series to update (update only).

CalendarEvent_RepeatEvery

integer

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

CalendarEvent_RepeatUntil

string

Filter by date the recurring series ends (create only).

CalendarEvent_RepeatOnMondays

boolean

Filter by include Mondays in the recurring schedule.

CalendarEvent_RepeatOnTuesdays

boolean

Filter by include Tuesdays in the recurring schedule.

CalendarEvent_RepeatOnWednesdays

boolean

Filter by include Wednesdays in the recurring schedule.

CalendarEvent_RepeatOnThursdays

boolean

Filter by include Thursdays in the recurring schedule.

CalendarEvent_RepeatOnFridays

boolean

Filter by include Fridays in the recurring schedule.

CalendarEvent_RepeatOnSaturdays

boolean

Filter by include Saturdays in the recurring schedule.

CalendarEvent_RepeatOnSundays

boolean

Filter by include Sundays in the recurring schedule.

CalendarEvent_StartDateLocal

string

Filter by event start date and time in the location’s local timezone.

CalendarEvent_EndDateLocal

string

Filter by event end date and time in the location’s local timezone.

CalendarEvent_PublishDateLocal

string

Filter by publish date and time in the location’s local timezone.

CalendarEvent_AfterEventNotificationJobId

string

Filter by background job ID for the scheduled post-event notification email.

CalendarEvent_SendAfterEventNotification

boolean

Filter by send a follow-up notification email to attendees after the event ends.

CalendarEvent_AfterEventNotificationText

string

Filter by custom message body for the post-event notification email.

CalendarEvent_SendBeforeEventNotification

boolean

Filter by send a reminder notification email to attendees before the event starts.

CalendarEvent_HasEventForm

boolean

Filter by a form is linked to this event that attendees are asked to complete.

CalendarEvent_SendEventFormByEmail

boolean

Filter by send the linked event form to attendees by email.

CalendarEvent_FormPage

integer

Filter by iD of the form page linked to this event.

CalendarEvent_FormPage_Name

string

Filter by name of the linked form page.

Range Filters

from_CalendarEvent_StartDate

string

Filter by event start date and time (UTC) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_StartDate

string

Filter by event start date and time (UTC) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_EndDate

string

Filter by event end date and time (UTC) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_EndDate

string

Filter by event end date and time (UTC) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_Allocation

integer

Filter by maximum number of attendees; leave empty for unlimited greater than or equal to this value.

to_CalendarEvent_Allocation

integer

Filter by maximum number of attendees; leave empty for unlimited less than or equal to this value.

from_CalendarEvent_PublishDate

string

Filter by date and time the event becomes visible on the Members Portal (UTC) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_PublishDate

string

Filter by date and time the event becomes visible on the Members Portal (UTC) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_RepeatEvery

integer

Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks) greater than or equal to this value.

to_CalendarEvent_RepeatEvery

integer

Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks) less than or equal to this value.

from_CalendarEvent_RepeatUntil

string

Filter by date the recurring series ends (create only) greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_RepeatUntil

string

Filter by date the recurring series ends (create only) less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_StartDateLocal

string

Filter by event start date and time in the location’s local timezone greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_StartDateLocal

string

Filter by event start date and time in the location’s local timezone less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_EndDateLocal

string

Filter by event end date and time in the location’s local timezone greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_EndDateLocal

string

Filter by event end date and time in the location’s local timezone less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_PublishDateLocal

string

Filter by publish date and time in the location’s local timezone greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_PublishDateLocal

string

Filter by publish date and time in the location’s local timezone less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_CreatedOn

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_CreatedOn

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CalendarEvent_UpdatedOn

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CalendarEvent_UpdatedOn

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/content/calendarevents?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/content/calendarevents?CalendarEvent_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/content/calendarevents?from_CalendarEvent_UpdatedOn=2025-01-01T00:00&to_CalendarEvent_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records

CalendarEvent[]

The list of CalendarEvent records matching the query. See the Get one CalendarEvent endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each CalendarEvent. The following fields are not populated in the Records[] response: ShortDescription, LongDescription, TicketNotes, EnableWaitList, AskBuyerAddress, ShowEventAttendees, Location, VenueAddress, ShowInHomeBanner, ShowInHomePage, IncludeZoomInvite, CreateZoomWebinarInvite, ZoomWebinarAlternativeHosts, WebAddress, FacebookPage, TicketsPage, RepeatEvent, Repeats, WhichEventsToUpdate, RepeatEvery, RepeatUntil, RepeatOnMondays, RepeatOnTuesdays, RepeatOnWednesdays, RepeatOnThursdays, RepeatOnFridays, RepeatOnSaturdays, RepeatOnSundays, SendAfterEventNotification, AfterEventNotificationText, SendBeforeEventNotification, HasEventForm, SendEventFormByEmail.To get all fields, fetch the full record using the Get one CalendarEvent endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = ascending, 1 = descending).

FirstItem

integer

Index of the first item on the current page.

LastItem

integer

Index of the last item on the current page.

TotalItems

integer

Total number of matching records across all pages.

TotalPages

integer

Total number of pages.

HasNextPage

boolean

Whether there is a next page of results.

HasPreviousPage

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "Name": "",
      "HostFullName": null,
      "ResourceId": null,
      "StartDate": "2025-01-15T10:30:00Z",
      "EndDate": "2025-01-15T10:30:00Z",
      "Allocation": null,
      "EventCategories": [],
      "PublishDate": null,
      "AllowComments": false,
      "ZoomEventData": null,
      "ZoomMeetingId": null,
      "OnlyForContacts": false,
      "OnlyForMembers": false,
      "SmallLogoFileName": null,
      "NewSmallLogoUrl": null,
      "ClearSmallLogoFile": null,
      "LargeLogoFileName": null,
      "NewLargeLogoUrl": null,
      "ClearLargeLogoFile": null,
      "RepeatSeriesUniqueId": null,
      "StartDateLocal": null,
      "EndDateLocal": null,
      "PublishDateLocal": null,
      "AfterEventNotificationJobId": null,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one CalendarEventRetrieve a single CalendarEvent record by its Id.

Search CalendarEvents

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200