Search CalendarEvents

GET

api

content

calendarevents

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

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-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

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

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

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location this event belongs to..

string

Filter by name of the event displayed on the Members Portal; required..

string

Filter by full name of the person hosting or presenting the event..

string

Filter by short plain-text summary shown under the event name on the Members Portal..

string

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

string

Filter by additional notes appended to ticket confirmation emails..

boolean

Filter by whether customers can join a waiting list when the event is at full capacity..

boolean

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

boolean

Filter by whether the attendee list is displayed on the Members Portal event page..

string

Filter by venue or room name displayed on the event page; changing it notifies registered attendees..

string

Filter by street address of the event venue..

integer

Filter by 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

Filter by display value for Resource.Name..

string

Filter by event start date and time in UTC; must be before EndDate..

string

Filter by event end date and time in UTC; must be after StartDate..

integer

Filter by 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..

string

Filter by 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

Filter by whether this event is displayed in the home page banner on the Members Portal..

boolean

Filter by whether this event is displayed on the Members Portal home page..

boolean

Filter by whether customers can post comments on the event..

boolean

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

boolean

Filter by whether to create a Zoom webinar instead of a regular conference call for this event..

string

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

string

Filter by internal raw Zoom meeting payload maintained by the Zoom integration..

string

Filter by internal Zoom meeting or webinar identifier maintained by the Zoom integration..

boolean

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

boolean

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

string

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

string

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

boolean

Filter by remove the current small event image.

string

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

string

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

boolean

Filter by remove the current large event image.

string

Filter by optional URL of an external website related to this event..

string

Filter by optional URL of a Facebook event or page for this event..

string

Filter by optional URL of an external ticketing page for this event..

string

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

boolean

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

integer

Filter by recurrence cycle for the series: Daily, Weekly, Monthly, Yearly, FirstOfMonth, SecondOfMonth, ThirdOfMonth, FourthOfMonth, or LastOfMonth..

integer

Filter by for an update to a recurring event, selects the scope: UpdateThisEventOnly, UpdateFutureEventsOnly, UpdateAllEvents, DeleteAllEvents, DeleteEventsAfterThis, or UpdateEventProducts..

integer

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

string

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

boolean

Filter by whether the recurring series includes Mondays..

boolean

Filter by whether the recurring series includes Tuesdays..

boolean

Filter by whether the recurring series includes Wednesdays..

boolean

Filter by whether the recurring series includes Thursdays..

boolean

Filter by whether the recurring series includes Fridays..

boolean

Filter by whether the recurring series includes Saturdays..

boolean

Filter by whether the recurring series includes Sundays..

string

Filter by system-maintained local-time representation of StartDate; set StartDate (UTC) instead..

string

Filter by system-maintained local-time representation of EndDate; set EndDate (UTC) instead..

string

Filter by system-maintained local-time representation of PublishDate; set PublishDate (UTC) instead..

string

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

boolean

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

string

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

boolean

Filter by whether a reminder email is sent to attendees within 24 hours before the event starts..

boolean

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

boolean

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

integer

Filter by optional ID of the form page attendees are asked to complete for this event..

string

Filter by display value for FormPage.Name..

string

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

string

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

string

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

Range Filters

string

Filter by event start date and time in UTC; must be before EndDate. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by event start date and time in UTC; must be before EndDate. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by event end date and time in UTC; must be after StartDate. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by event end date and time in UTC; must be after StartDate. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by 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. greater than or equal to this value.

integer

string

Filter by 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. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by 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. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by optional positive number of cycles between occurrences; for example, 2 with Weekly repeats every two weeks. greater than or equal to this value.

integer

Filter by optional positive number of cycles between occurrences; for example, 2 with Weekly repeats every two weeks. less than or equal to this value.

string

Filter by optional final UTC date for creating occurrences in the recurring series; when omitted, occurrences are created for one year. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional final UTC date for creating occurrences in the recurring series; when omitted, occurrences are created for one year. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by system-maintained local-time representation of StartDate; set StartDate (UTC) instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by system-maintained local-time representation of StartDate; set StartDate (UTC) instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by system-maintained local-time representation of EndDate; set EndDate (UTC) instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by system-maintained local-time representation of EndDate; set EndDate (UTC) instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by system-maintained local-time representation of PublishDate; set PublishDate (UTC) instead. greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by system-maintained local-time representation of PublishDate; set PublishDate (UTC) instead. less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

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

string

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

string

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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/calendarevents?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/calendarevents',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/calendarevents?' + new URLSearchParams({
    CalendarEvent_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/calendarevents',
    params={
        'CalendarEvent_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/content/calendarevents?' + new URLSearchParams({
    from_CalendarEvent_UpdatedOn: '2025-01-01T00:00',
    to_CalendarEvent_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/content/calendarevents',
    params={
        'from_CalendarEvent_UpdatedOn': '2025-01-01T00:00',
        'to_CalendarEvent_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

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: WhichEventsToUpdate.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.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

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

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CalendarEvents

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

import requests

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

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', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

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

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200