CalendarEventCategories
Search CalendarEventCategories
Search and list CalendarEventCategory records with filtering, sorting, and pagination.
GET
Search CalendarEventCategories
A CalendarEventCategory groups events by type or theme within a location. Categories appear as filters on the Events page of the Members Portal, letting customers quickly find relevant events. Events that share the same category are also shown as related events when a customer views the detail page of a specific event.
Assign categories to events via the
EventCategories list on the CalendarEvent entity.
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 CalendarEventCategory-List role.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 the location this event category belongs to.
string
Filter by category name shown as a filter on the Members Portal.
Range Filters
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
Filtering by Title
Range filters
Response
200
CalendarEventCategory[]
The list of CalendarEventCategory records matching the query. See the Get one CalendarEventCategory endpoint for the full list of properties returned for each record.
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
Search CalendarEventCategories