Skip to main content
GET
/
api
/
public
/
events
{
  "400 Bad Request": {}
}

​
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

​
onlyHomePage
boolean
required
Must be true. Returns only events that the operator has configured to appear on the portal home page.
​
_shape
string
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 same EventList structure as List Events. See that endpoint for the full field breakdown.

​
Key Event Fields

FieldTypeDescription
IdnumberUnique numeric identifier for the event
NamestringEvent title (localised)
ShortDescriptionstringBrief event description
StartDateUtcstringEvent start date/time (UTC)
EndDateUtcstringEvent end date/time (UTC)
HasLargeImagebooleanWhether the event has a large image
ShowInHomePagebooleanWhether flagged for the home page
HasTicketsbooleanWhether the event has ticket products
SoldOutbooleanWhether all tickets are sold out
ChepeastPricenumberLowest ticket price
MostExpensivePricenumberHighest ticket price
BusinessobjectLocation object (Id, Name)

​
Examples

​
Fetch home page events

GET /api/public/events?onlyHomePage=true

{
  "PastEvents": false,
  "Categories": [],
  "Category": null,
  "CalendarEvents": {
    "Records": [
      {
        "Id": 420,
        "Name": "Startup Pitch Night",
        "ShortDescription": "Watch 8 local startups pitch to a panel of investors.",
        "StartDateUtc": "2026-03-28T18:00:00Z",
        "EndDateUtc": "2026-03-28T21:00:00Z",
        "HasLargeImage": true,
        "ShowInHomePage": true,
        "HasTickets": true,
        "SoldOut": false,
        "ChepeastPrice": 0,
        "MostExpensivePrice": 25.0,
        "Business": { "Id": 5, "Name": "Downtown Coworking Hub" }
      }
    ],
    "CurrentPage": 1,
    "CurrentPageSize": 25,
    "TotalItems": 1,
    "TotalPages": 1,
    "HasNextPage": false,
    "HasPreviousPage": false
  }
}

​
TypeScript Integration

import endpoints from '@/api/endpoints'

// endpoints.events.upcomingEvents is a pre-built URL string:
// 'api/public/events?onlyHomePage=true'
const { resource: upcomingEvents } = useData(httpClient, endpoints.events.upcomingEvents)

​
Usage in Portal

ContextSource file
Upcoming Events dashboard section (personal dashboard)src/views/user/dashboards/personal/components/UpcomingEvents/UpcomingEventsDashboardSection.tsx

​
Error Responses

​
400 Bad Request
error
Invalid query parameter value.
MethodEndpointDescription
GET/api/public/eventsFull paginated events list with all filters
GET/api/public/events/{id}Full detail for a specific event
GET/api/public/events/myTickets held by the authenticated customer