Skip to main content
GET
/
{businessType}
s
/
{businessId}
/
sessions
Get Business Sessions
curl --request GET \
  --url https://api.example.com/{businessType}s/{businessId}/sessions
{
  "data": [
    {}
  ],
  "data.id": "<string>",
  "data.createdAt": "<string>",
  "data.startedAt": "<string>",
  "data.endedAt": "<string>",
  "data.durationSeconds": 123,
  "data.rating": 123,
  "data.note": "<string>",
  "data.user": {},
  "data.user.displayName": "<string>",
  "data.user.avatarUrl": "<string>",
  "data.cigar": {},
  "data.cigar.id": "<string>",
  "data.cigar.name": "<string>",
  "data.cigar.brandName": "<string>",
  "data.cigar.imageUrl": "<string>",
  "data.venue": {},
  "meta": {}
}
Returns recent smoke sessions associated with a specific Boxpressd business. This endpoint is used internally by the Boxpressd Sites SDK when calling getBoxpressdSessions without a cigarId.
​
businessType
string
required
The business type.Supported values include venue and brand.
​
businessId
string
required
The unique Boxpressd business identifier.
​
limit
number
The maximum number of sessions to return.
​
offset
number
The number of sessions to skip for pagination.
​
from
string
Return sessions created on or after this ISO date.
​
to
string
Return sessions created on or before this ISO date.
​
featured
boolean
When supported, returns only featured sessions.

​
SDK Request

const url = `${context.apiBaseUrl}/${context.businessType}s/${
  context.businessId
}/sessions${query ? `?${query}` : ""}`

​
Example Request

curl "https://api.boxpressd.com/venues/stogies-chapin/sessions?limit=10" \
  -H "Authorization: Bearer YOUR_API_KEY"

​
Example Response

{
  "data": [
    {
      "id": "ses_12345",
      "createdAt": "2026-07-18T23:12:00.000Z",
      "startedAt": "2026-07-18T22:00:00.000Z",
      "endedAt": "2026-07-18T23:10:00.000Z",
      "durationSeconds": 4200,
      "rating": 4.8,
      "note": "Excellent evening smoke.",
      "user": {
        "id": "usr_12345",
        "displayName": "Trevor B.",
        "avatarUrl": "https://cdn.boxpressd.com/users/usr_12345.jpg"
      },
      "cigar": {
        "id": "cgr_12345",
        "name": "Philosopher's Folly",
        "brandName": "Example Cigars",
        "imageUrl": "https://cdn.boxpressd.com/cigars/cgr_12345.jpg"
      },
      "venue": {
        "id": "stogies-chapin",
        "name": "Stogies Cigar Lounge & Tap House"
      }
    }
  ],
  "meta": {
    "count": 1,
    "limit": 10,
    "offset": 0
  }
}

​
Response

​
data
BoxpressdSession[]
required
The list of sessions returned for the requested business.
​
data.id
string
required
The unique session identifier.
​
data.createdAt
string
required
The date and time the session was created as an ISO string.
​
data.startedAt
string
The date and time the session started as an ISO string.
​
data.endedAt
string
The date and time the session ended as an ISO string.
​
data.durationSeconds
number
The total session duration in seconds.
​
data.rating
number
Optional rating associated with the session.
​
data.note
string
Optional public note associated with the session.
​
data.user
object
required
The public user summary associated with the session.
​
data.user.displayName
string
required
The public display name for the user.
​
data.user.avatarUrl
string
The user’s public avatar URL, when available.
​
data.cigar
object
The cigar associated with the session.
​
data.cigar.id
string
The cigar identifier.
​
data.cigar.name
string
The cigar display name.
​
data.cigar.brandName
string
The cigar brand display name.
​
data.cigar.imageUrl
string
The cigar image URL.
​
data.venue
object
The venue associated with the session, when available.
​
meta
object
Pagination and result metadata.