Skip to main content
GET
/
venues
/
{businessId}
/
checkins
Get Checkins
curl --request GET \
  --url https://api.example.com/venues/{businessId}/checkins
{
  "data": [
    {}
  ],
  "data.id": "<string>",
  "data.createdAt": "<string>",
  "data.note": "<string>",
  "data.rating": 123,
  "data.user": {},
  "data.user.id": "<string>",
  "data.user.displayName": "<string>",
  "data.user.avatarUrl": "<string>",
  "data.venue": {},
  "data.venue.id": "<string>",
  "data.venue.name": "<string>",
  "meta": {},
  "meta.count": 123,
  "meta.limit": 123,
  "meta.offset": 123
}
Returns recent checkins for a specific Boxpressd venue. This endpoint is used internally by the Boxpressd Sites SDK when calling getBoxpressdCheckins or useCheckins.
checkins are currently venue-specific. The SDK only calls this endpoint when the resolved business context is a venue.
​
businessId
string
required
The unique Boxpressd venue identifier.
​
limit
number
The maximum number of checkins to return.
​
offset
number
The number of checkins to skip for pagination.
​
from
string
Return checkins created on or after this ISO date.
​
to
string
Return checkins created on or before this ISO date.

​
SDK Request

The SDK builds this request from the resolved business context: 
const url = `${context.apiBaseUrl}/venues/${context.businessId}/checkins${
  query ? `?${query}` : ""
}`
For example: 
GET https://api.boxpressd.com/venues/stogies-chapin/checkins?limit=10

​
Example Request

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

​
Example Response

{
  "data": [
    {
      "id": "chk_12345",
      "createdAt": "2026-07-18T22:14:00.000Z",
      "note": "Great night at the lounge.",
      "rating": 5,
      "user": {
        "id": "usr_12345",
        "displayName": "Trevor B.",
        "avatarUrl": "https://cdn.boxpressd.com/users/usr_12345.jpg"
      },
      "venue": {
        "id": "stogies-chapin",
        "name": "Stogies Cigar Lounge & Tap House"
      }
    }
  ],
  "meta": {
    "count": 1,
    "limit": 10,
    "offset": 0
  }
}

​
Response

​
data
BoxpressdCheckin[]
required
The list of checkins returned for the requested venue.
​
data.id
string
required
The unique checkin identifier.
​
data.createdAt
string
required
The date and time the checkin was created as an ISO string.
​
data.note
string
Optional public note associated with the checkin.
​
data.rating
number
Optional rating associated with the checkin.
​
data.user
object
required
The public user summary associated with the checkin.
​
data.user.id
string
The user identifier, when available.
​
data.user.displayName
string
required
The public display name for the user.The SDK normalizes this value using the fallback order display_name → first_name + last initial → "Boxpressd User".
​
data.user.avatarUrl
string
The user’s public avatar URL, when available.
​
data.venue
object
The venue summary associated with the checkin.
​
data.venue.id
string
The venue identifier.
​
data.venue.name
string
The venue display name.
​
meta
object
Pagination and result metadata.
​
meta.count
number
The number of checkins returned.
​
meta.limit
number
The requested result limit.
​
meta.offset
number
The requested pagination offset.
Most public SDK implementations should use the SDK helper or hook instead of calling this endpoint directly. 
import { getBoxpressdCheckins } from "@boxpressd/sites-sdk/checkins"

const checkins = await getBoxpressdCheckins({
  limit: 10
})

"use client"

import { useCheckins } from "@boxpressd/sites-sdk/checkins"

const { data, isLoading, error } = useCheckins({
  limit: 10
})