Skip to main content
GET
/
{businessType}
s
/
{businessId}
/
events
Get Business Events
curl --request GET \
  --url https://api.example.com/{businessType}s/{businessId}/events
{
  "data": [
    {}
  ],
  "data.id": "<string>",
  "data.title": "<string>",
  "data.description": "<string>",
  "data.startsAt": "<string>",
  "data.endsAt": "<string>",
  "data.timezone": "<string>",
  "data.locationName": "<string>",
  "data.address": "<string>",
  "data.imageUrl": "<string>",
  "data.featured": true,
  "data.externalUrl": "<string>",
  "data.ticketUrl": "<string>",
  "meta": {},
  "meta.count": 123,
  "meta.limit": 123,
  "meta.offset": 123
}
Returns events for a specific Boxpressd business. This endpoint is used internally by the Boxpressd Sites SDK when calling getBoxpressdEvents or useEvents.
businessType
string
required
The business type.Supported values include venue and brand.The SDK automatically pluralizes this value when building the request path.
businessId
string
required
The unique Boxpressd business identifier.
status
string
Filter events by status.Supported values include upcoming, past, and all.
limit
number
The maximum number of events to return.
offset
number
The number of events to skip for pagination.
When supported, returns only featured events.
from
string
Return events starting on or after this ISO date.
to
string
Return events starting on or before this ISO date.

Example Request

curl "https://api.boxpressd.com/venues/stogies-chapin/events?status=upcoming&limit=6" \
  -H "Authorization: Bearer YOUR_API_KEY"

Example Response

{
  "data": [
    {
      "id": "evt_12345",
      "title": "Cigar Night",
      "description": "Join us for an evening of premium cigars, drinks, and community.",
      "startsAt": "2026-07-18T23:00:00.000Z",
      "endsAt": "2026-07-19T02:00:00.000Z",
      "timezone": "America/New_York",
      "locationName": "Stogies Cigar Lounge & Tap House",
      "address": "Chapin, SC",
      "imageUrl": "https://cdn.boxpressd.com/events/evt_12345.jpg",
      "featured": true,
      "externalUrl": null,
      "ticketUrl": null
    }
  ],
  "meta": {
    "count": 1,
    "limit": 6,
    "offset": 0
  }
}

Response

data
BoxpressdEvent[]
required
The list of events returned for the requested business.
data.id
string
required
The unique event identifier.
data.title
string
required
The event title.
data.description
string
The event description.
data.startsAt
string
required
The event start date and time as an ISO string.
data.endsAt
string
The event end date and time as an ISO string.
data.timezone
string
The timezone associated with the event.
data.locationName
string
The display name of the event location.
data.address
string
The event address or location summary.
data.imageUrl
string
The event image URL.
Whether the event is featured.
data.externalUrl
string
An optional external event URL.
data.ticketUrl
string
An optional ticket or registration URL.
meta
object
Pagination and result metadata.
meta.count
number
The number of events returned.
meta.limit
number
The requested result limit.
meta.offset
number
The requested pagination offset.