/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

1 total

Query · 1

kindstring | string

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').

Request

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"

Response

List of calendars with live event status.

{
  "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
}

All response codes

1 status code documented

Need an API key?

All BizKitHub API endpoints require authentication via API key.

Get API Key