Events
List Upcoming Home Page Events
Returns published events flagged for the home page, used to populate upcoming event widgets on the portal home.
GET
List Upcoming Home Page Events
List Upcoming Home Page Events
Returns a list of published events that the operator has flagged to appear on the portal home page (onlyHomePage=true). This is the shortcut endpoint behind endpoints.events.upcomingEvents — equivalent to calling the events list with onlyHomePage=true.
This endpoint is a convenience alias for
GET /api/public/events?onlyHomePage=true. See List Events for the
full parameter and response documentation.Authentication
No authentication required.Query Parameters
Must be
true. Returns only events that the operator has configured to appear on the portal home page.Comma-separated list of field paths to include in the response. When provided, only the
specified fields are returned — useful for reducing payload size. Supports nested paths
using dot notation. Example:
_shape=CalendarEvents.Records.Name,CalendarEvents.Records.StartDateUtc,CalendarEvents.TotalItems.Response
Returns the sameEventList structure as List Events. See that endpoint for the full field breakdown.
Key Event Fields
Examples
Fetch home page events
TypeScript Integration
Usage in Portal
Error Responses
Invalid query parameter value.
Related Endpoints
List Upcoming Home Page Events