BizKitHub
DocsAPI ReferenceCalendar Event/bff/calendar/event-detail
getCalendar EventAdmin BFF

/bff/calendar/event-detail

Returns comprehensive event information including calendar context, event type, attendees, orders, reminders, location address, passwords, reservation status, and recurrence data.

Calendar EventgetBffCalendarEvent-detail

Parameters

1 query

Query parameters

· 1
eventIdstringRequired

External event code identifier.

Exampleexample_eventId

Response schema

1 status code documented

200SuccessFull event detail with all associated data.
idstringRequired

External event code identifier.

calendarIdstringRequired

External calendar code.

calendarNamestringRequired

Calendar display name.

calendarColorstringRequired

Calendar hex color (e.g., "#FF5733").

timezonestringRequired

Calendar timezone (e.g., "Europe/Prague").

startTimeDate | string | string | numberRequired

Event start time (UTC).

One of 4:
Variant 1
Date

Event start time (UTC).

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
endTimeDate | string | string | numberRequired

Event end time (UTC).

One of 4:
Variant 1
Date

Event end time (UTC).

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
durationMinutesnumberRequired

Computed event duration in minutes.

reservedBlockingToDate | string | string | numberOptional

Time until which the event blocks the calendar slot.

One of 4:
Variant 1
Date

Time until which the event blocks the calendar slot.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
titlestringRequired

Event title.

isAllDaybooleanRequired

Whether the event spans the entire day.

isBlockingbooleanRequired

Whether the event blocks conflicting reservations.

isStornobooleanRequired

Whether the event has been cancelled.

visibility"organisation" | "shared" | "private" | nullRequired
One of 2:
Variant 1
"organisation" | "shared" | "private"

Per-event visibility override. NULL = inherit from calendar. "private" makes the event invisible to everyone but the owner across all orgs.

Variant 2
null
isOpenButtonAvailablebooleanOptional

Whether a smart lock unlock button should be shown.

lockOnlinebooleanOptional

Smart lock gateway connectivity. Populated only when the calendar has a lock. true = gateway reachable, false = currently in an outage.

typeCodestringOptional

Event type code (e.g., "workshop").

typeLabelstringOptional

Event type display label.

colorstringOptional

Event type hex color.

descriptionstringOptional

Event description (rich text).

agendastringOptional

Event agenda / schedule.

urlstringOptional

External URL associated with the event.

insertedDateDate | string | string | numberRequired

Date when the event was created.

One of 4:
Variant 1
Date

Date when the event was created.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
locationTitlestringOptional

Location name / label.

locationobjectOptional

Full location address resolved from the address registry.

titlestringOptional

Location name.

streetAddressstringOptional

Street and house number.

citystringOptional

City name.

postalCodestringOptional

Postal / ZIP code.

stateRegionstringOptional

State or region.

cityPartstringOptional

City district / part.

latitudestringOptional

GPS latitude.

longitudestringOptional

GPS longitude.

eventTypeProductobjectOptional

Product linked to the event type (for pricing / inventory).

codestringRequired

Product code.

namestringRequired

Product name.

pricestringRequired

Product price.

reminderListobject[]Required

Active reminders for this event.

Each array item:
dateDate | string | string | numberRequired

Absolute reminder trigger time.

One of 4:
Variant 1
Date

Absolute reminder trigger time.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
relativeTimestringRequired

Relative time before event (e.g., "30m", "1h", "1d").

orderListobject[]Required

Orders / reservations linked to this event.

Each array item:
orderNumberstringRequired

Order number.

hashstringRequired

Order hash for URL identification.

paidbooleanRequired

Whether the order has been paid.

isStornobooleanRequired

Whether the order item is cancelled.

customerIdstringOptional

Customer external ID.

customerNamestringOptional

Customer full name.

emailstringOptional

Customer email.

phonestringOptional

Customer phone.

attendeeListobject[]Required

Event attendees / participants sorted by organizer status and date.

Each array item:
namestringOptional

Attendee name.

emailstringOptional

Attendee email.

phonestringOptional

Attendee phone.

organizerbooleanRequired

Whether this attendee is the event organizer.

requiredbooleanRequired

Whether attendance is required.

acceptedbooleanRequired

Whether the attendee has accepted the invitation.

insertedDateDate | string | string | numberRequired

Date when the attendee was added.

One of 4:
Variant 1
Date

Date when the attendee was added.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
passwordListobject[]Required

Smart lock passwords generated for this event.

Each array item:
passwordstringRequired

Smart lock temporary password.

state"pending" | "active" | "expired" | "deleted"Required

Password lifecycle: "pending" = uploaded, waiting for start_date; "active" = currently valid; "expired" = past end_date; "deleted" = removed from the physical lock.

lockAccessobjectOptional

Lock access log — present only when the event's calendar is bound to a smart lock. Combines provisioning status with the physical lock's recorded activity in the event window.

status"pending" | "ready" | "fallback_backup" | "failed" | "manual_override" | "not_required" | nullRequired
One of 2:
Variant 1
"pending" | "ready" | "fallback_backup" | "failed" | "manual_override" | "not_required"

Provisioning outcome for the event's access code: "pending" = queued, "ready" = uploaded and active on the lock, "fallback_backup" = degraded, reverted to the shared backup passcode, "failed" = could not provision, "manual_override" = operator bypassed automation, "not_required" = event does not need a code. NULL = never evaluated.

Variant 2
null
lastAttemptAtDate | string | string | numberOptional

Last time the provisioner touched this event.

One of 4:
Variant 1
Date

Last time the provisioner touched this event.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
failureReasonstringOptional

Short human-readable reason for a failed provisioning.

firstUnlockAtDate | string | string | numberOptional

First successful unlock observed in the event window.

One of 4:
Variant 1
Date

First successful unlock observed in the event window.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
lastActivityAtDate | string | string | numberOptional

Timestamp of the last lock/unlock record observed in the window. Proxy signal for "customer left" — not a hard check-out.

One of 4:
Variant 1
Date

Timestamp of the last lock/unlock record observed in the window. Proxy signal for "customer left" — not a hard check-out.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
unlockCountnumberRequired

Number of successful lock/unlock records in the event window.

failedAttemptCountnumberRequired

Number of failed attempts (bad passcode, etc.) in the event window.

usedBackupCodebooleanOptional

When any successful passcode unlock happened: true = only a non-event code (backup / other) was used, false = this event's issued code was used at least once. Absent when there was no passcode activity.

timelineobject[]Required

Chronological unlock/lock records in the event window (capped at 50).

Each array item:
atDate | string | string | numberRequired

When the lock/unlock happened (UTC).

One of 4:
Variant 1
Date

When the lock/unlock happened (UTC).

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
successbooleanRequired

Whether the attempt succeeded.

recordTypenumberRequired

Opaque TTLock record_type enum — pass-through for the UI.

matchedEventCodebooleanRequired

true = entered passcode is exactly the one issued for this event.

reservationobjectOptional

Reservation status when event type is linked to a product.

confirmednumberRequired

Number of confirmed reservations.

limitnumberRequired

Maximum capacity from product warehouse limit.

recurrenceobjectRequired

Recurrence series information with all related events.

isRecurrencebooleanRequired

Whether this event is part of a recurring series.

itemsobject[]Required
Each array item:
idstringRequired

External event code.

isParentbooleanOptional

Whether this is the root/parent event.

titlestringRequired

Event title.

startTimeDate | string | string | numberRequired

Event start time.

One of 4:
Variant 1
Date

Event start time.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
endTimeDate | string | string | numberRequired

Event end time.

One of 4:
Variant 1
Date

Event end time.

Variant 2
stringdate-time
Variant 3
stringdate
Variant 4
number
isStornobooleanRequired

Whether this occurrence is cancelled.

recurrenceRulestringOptional

iCalendar RRULE string (e.g., "FREQ=WEEKLY;BYDAY=MO,WE,FR").

Response example

application/json
{
  "id": "example_id",
  "calendarId": "example_calendarId",
  "calendarName": "example_calendarName",
  "calendarColor": "example_calendarColor",
  "timezone": "example_timezone",
  "durationMinutes": 0,
  "title": "example_title",
  "isAllDay": false,
  "isBlocking": false,
  "isStorno": false,
  "isOpenButtonAvailable": false,
  "lockOnline": false,
  "typeCode": "example_typeCode",
  "typeLabel": "example_typeLabel",
  "color": "example_color",
  "description": "example_description",
  "agenda": "example_agenda",
  "url": "example_url",
  "locationTitle": "example_locationTitle",
  "location": {
    "title": "example_title",
    "streetAddress": "example_streetAddress",
    "city": "example_city",
    "postalCode": "example_postalCode",
    "stateRegion": "example_stateRegion",
    "cityPart": "example_cityPart",
    "latitude": "example_latitude",
    "longitude": "example_longitude"
  },
  "eventTypeProduct": {
    "code": "example_code",
    "name": "example_name",
    "price": "example_price"
  },
  "reminderList": [
    {
      "relativeTime": "example_relativeTime"
    }
  ],
  "orderList": [
    {
      "orderNumber": "example_orderNumber",
      "hash": "example_hash",
      "paid": false,
      "isStorno": false,
      "customerId": "example_customerId",
      "customerName": "example_customerName",
      "email": "example_email",
      "phone": "example_phone"
    }
  ],
  "attendeeList": [
    {
      "name": "example_name",
      "email": "example_email",
      "phone": "example_phone",
      "organizer": false,
      "required": false,
      "accepted": false
    }
  ],
  "passwordList": [
    {
      "password": "example_password"
    }
  ],
  "lockAccess": {
    "failureReason": "example_failureReason",
    "unlockCount": 0,
    "failedAttemptCount": 0,
    "usedBackupCode": false,
    "timeline": [
      {
        "success": false,
        "recordType": 0,
        "matchedEventCode": false
      }
    ]
  },
  "reservation": {
    "confirmed": 0,
    "limit": 0
  },
  "recurrence": {
    "isRecurrence": false,
    "items": [
      {
        "id": "example_id",
        "isParent": false,
        "title": "example_title",
        "isStorno": false
      }
    ]
  },
  "recurrenceRule": "example_recurrenceRule"
}

Request example

GET /bff/calendar/event-detail

get
curl -X GET "https://api.bizkithub.com/bff/calendar/event-detail?eventId=example_eventId" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY"

Need an API key?

All BizKitHub public API endpoints require authentication via API key.

Get API Key