> ## Documentation Index > Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt > Use this file to discover all available pages before exploring further. # Search CalendarEvents > Search and list CalendarEvent records with filtering, sorting, and pagination. 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 | Value | Name | | ----- | ------------- | | 1 | Daily | | 2 | Weekly | | 3 | Monthly | | 4 | Yearly | | 5 | FirstOfMonth | | 6 | SecondOfMonth | | 7 | ThirdOfMonth | | 8 | LastOfMonth | | 9 | FourthOfMonth | | Value | Name | | ----- | ---------------------- | | 1 | UpdateThisEventOnly | | 2 | UpdateFutureEventsOnly | | 3 | UpdateAllEvents | | 4 | DeleteAllEvents | | 5 | DeleteEventsAfterThis | | 6 | UpdateEventProducts | ## Query Parameters ### Pagination & Sorting The page number to retrieve. The number of records per page. The property name to sort results by (e.g. `Name`, `CreatedOn`). Sort direction. `0` for ascending, `1` for descending. ### Filters Filter by the location this event belongs to. Filter by event name. Filter by full name of the event host or presenter. Filter by brief summary shown under the event name on the Members Portal. Filter by full event description visible when a customer opens the event on the Members Portal. Filter by additional notes included in ticket confirmation emails. Filter by allow customers to join a waiting list when the event is at full capacity. Filter by request the buyer's postal address during ticket checkout. Filter by display the attendee list on the Members Portal event page. Filter by venue or room name displayed on the event page. Filter by street address of the event venue. Filter by resource linked to this event; automatically blocked from bookings for the event's duration. Filter by event start date and time (UTC). Filter by event end date and time (UTC). Filter by maximum number of attendees; leave empty for unlimited. Filter by date and time the event becomes visible on the Members Portal (UTC). Filter by display this event in the home page banner on the Members Portal. Filter by display this event on the Members Portal home page. Filter by allow customers to post comments on the event. Filter by attach a Zoom conference call link to this event. Filter by create a Zoom webinar instead of a regular conference call. Filter by comma-separated email addresses of alternative Zoom hosts who can start the meeting. Filter by raw Zoom meeting data returned after the Zoom event is created. Filter by zoom meeting or webinar ID. Filter by restrict event attendance to contacts only. Filter by restrict event attendance to members only. Filter by filename of the small event image shown in related-events sections (read-only; set via `NewSmallLogoUrl`). Filter by uRL of an image to upload as the small event image. Filter by remove the current small event image. Filter by filename of the large event image shown on the event list and detail page (read-only; set via `NewLargeLogoUrl`). Filter by uRL of an image to upload as the large event image. Filter by remove the current large event image. Filter by uRL of an external website related to this event. Filter by uRL of a Facebook event or page for this event. Filter by uRL of an external ticketing page for this event. Filter by unique identifier shared by all occurrences in a repeat series. Filter by create this event as a recurring series (create only). Filter by recurrence pattern for the event series. Filter by which events in the recurring series to update (update only). Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks). Filter by date the recurring series ends (create only). Filter by include Mondays in the recurring schedule. Filter by include Tuesdays in the recurring schedule. Filter by include Wednesdays in the recurring schedule. Filter by include Thursdays in the recurring schedule. Filter by include Fridays in the recurring schedule. Filter by include Saturdays in the recurring schedule. Filter by include Sundays in the recurring schedule. Filter by event start date and time in the location's local timezone. Filter by event end date and time in the location's local timezone. Filter by publish date and time in the location's local timezone. Filter by background job ID for the scheduled post-event notification email. Filter by send a follow-up notification email to attendees after the event ends. Filter by custom message body for the post-event notification email. Filter by send a reminder notification email to attendees before the event starts. Filter by a form is linked to this event that attendees are asked to complete. Filter by send the linked event form to attendees by email. Filter by iD of the form page linked to this event. Filter by name of the linked form page. ### Range Filters Filter by event start date and time (UTC) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by event start date and time (UTC) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by event end date and time (UTC) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by event end date and time (UTC) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by maximum number of attendees; leave empty for unlimited greater than or equal to this value. Filter by maximum number of attendees; leave empty for unlimited less than or equal to this value. 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`. 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`. Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks) greater than or equal to this value. Filter by number of cycles between occurrences (e.g. 2 with Weekly means every two weeks) less than or equal to this value. Filter by date the recurring series ends (create only) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by date the recurring series ends (create only) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. 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`. 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`. 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`. 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`. Filter by publish date and time in the location's local timezone greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter by publish date and time in the location's local timezone less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`. Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`. ## Code Examples ### Simple listing ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/content/calendarevents?page=1&size=15&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} curl -X GET \ "https://spaces.nexudus.com/api/content/calendarevents?CalendarEvent_Name=example-value&orderBy=Name&dir=0" \ -H "Authorization: Bearer YOUR_TOKEN" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 ```bash cURL theme={null} 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" ``` ```javascript JavaScript theme={null} 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(); ``` ```python Python theme={null} 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 The list of CalendarEvent records matching the query. See the [Get one CalendarEvent](/rest-api/content/get-calendarevents-by-id) 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](/rest-api/content/get-calendarevents-by-id) 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. Current page number. Number of records per page. The field used for sorting. The sort direction (`0` = ascending, `1` = descending). Index of the first item on the current page. Index of the last item on the current page. Total number of matching records across all pages. Total number of pages. Whether there is a next page of results. Whether there is a previous page of results. ```json Example Response theme={null} { "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 } ```