BizKitHub
DocsAPI ReferenceCalendar/bff/calendar/calendar-list
getCalendarAdmin BFF

/bff/calendar/calendar-list

Returns all calendars accessible to the authenticated member. Includes live status: currently running event, next upcoming event, and statistics. The viewer's own personal calendar is always pinned as the first row.

CalendargetBffCalendarCalendar-list

Parameters

1 query

Query parameters

· 1
kind"organisation" | "personal"Optional

Which slice of the directory to return. 'organisation' (default) = team / booking / resource calendars plus the viewer's own personal calendar pinned first. 'personal' = personal calendars (own + colleagues whose visibility is 'organisation').

Response schema

1 status code documented

200SuccessList of calendars with live event status.
itemsobject[]Required
Each array item:

Calendar item with live status.

idstringRequired

External calendar code.

namestringRequired

Calendar display name.

internalDescriptionstringOptional

Internal note (not shown to customers).

colorstringRequired

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

timezonestringRequired

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

insertedDateDate | string | string | numberRequired

Date when the calendar was created.

One of 4:
Variant 1
Date

Date when the calendar was created.

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

Whether a smart lock device is connected.

kindstringRequired

Calendar kind: 'organisation' (team/booking), 'personal' (owned by a member), 'resource', 'external_mirror'.

isOwnbooleanRequired

True when this is the viewer's own personal calendar.

totalEventsnumberRequired

Total number of non-cancelled events.

upcomingEventsnumberRequired

Number of future events (start_time > now).

currentEventobjectOptional

Event that is running right now (start <= now < end). Undefined if idle.

idstringRequired

External event code.

titlestringRequired

Title of the currently running event.

startTimeDate | string | string | numberRequired

Start time of the current event.

One of 4:
Variant 1
Date

Start time of the current event.

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

End time of the current event.

One of 4:
Variant 1
Date

End time of the current event.

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

Nearest future event. Undefined if nothing is scheduled.

idstringRequired

External event code.

titlestringRequired

Title of the next upcoming event.

startTimeDate | string | string | numberRequired

Start time of the next event.

One of 4:
Variant 1
Date

Start time of the next event.

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

End time of the most recent past event. Useful for "last active" display.

One of 4:
Variant 1
Date

End time of the most recent past event. Useful for "last active" display.

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

Total number of calendars returned.

Response example

application/json
{
  "items": [
    {
      "id": "example_id",
      "name": "example_name",
      "internalDescription": "example_internalDescription",
      "color": "example_color",
      "timezone": "example_timezone",
      "hasLock": false,
      "kind": "example_kind",
      "isOwn": false,
      "totalEvents": 0,
      "upcomingEvents": 0,
      "currentEvent": {
        "id": "example_id",
        "title": "example_title"
      },
      "nextEvent": {
        "id": "example_id",
        "title": "example_title"
      }
    }
  ],
  "itemCount": 0
}

Request example

GET /bff/calendar/calendar-list

get
curl -X GET "https://api.bizkithub.com/bff/calendar/calendar-list" \
  -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