API Reference
Get Business Events
Return events for a Boxpressd venue or brand.
GET
Get Business Events
Returns events for a specific Boxpressd business.
This endpoint is used internally by the Boxpressd Sites SDK when calling
getBoxpressdEvents or useEvents.
The business type.Supported values include
venue and brand.The SDK automatically pluralizes this value when building the request path.The unique Boxpressd business identifier.
Filter events by status.Supported values include
upcoming, past, and all.The maximum number of events to return.
The number of events to skip for pagination.
When supported, returns only featured events.
Return events starting on or after this ISO date.
Return events starting on or before this ISO date.
Example Request
Example Response
Response
The list of events returned for the requested business.
The unique event identifier.
The event title.
The event description.
The event start date and time as an ISO string.
The event end date and time as an ISO string.
The timezone associated with the event.
The display name of the event location.
The event address or location summary.
The event image URL.
Whether the event is featured.
An optional external event URL.
An optional ticket or registration URL.
Pagination and result metadata.
The number of events returned.
The requested result limit.
The requested pagination offset.
Get Business Events