Read a calendar with its current and upcoming bookings

2 parameters

installation_idstringrequired

Room booking installation id

idstringrequired

Calendar id, as listRoomBookingCalendars answers it

3 status codes

200Success

dataobjectoptional

401Unauthorized

errorstringoptional

404Not a calendar id

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Not a calendar id.

import { Client } from "trmnl-octri-demo-sdk";

const client = new Client({
  baseUrl: "https://{defaultHost}",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.calendars.get({
  installationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  id: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21",
});

{
  "data": {
    "booking_mode": "null",
    "bound_device_ids": [
      1
    ],
    "capacity": 1,
    "current_booking": {
      "all_day": true,
      "booked_with_trmnl": true,
      "ends_at": "example_value",
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "source": "owner",
      "starts_at": "example_value",
      "status": "confirmed",
      "title": "Example Title"
    },
    "feed_backed": true,
    "ics_url": "https://example.com",
    "id": "ical:12",
    "kind": "ical",
    "last_sync_error": "example_value",
    "last_synced_at": "example_value",
    "name": "Boardroom",
    "public_booking_token": "example_key_abc123",
    "public_booking_url": "https://example.com",
    "resource_kind": "room",
    "show_booking_qr": true,
    "show_company_logo": true,
    "timezone": "Europe/Amsterdam",
    "upcoming_bookings": [
      {
        "all_day": true,
        "booked_with_trmnl": true,
        "ends_at": "example_value",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "source": "owner",
        "starts_at": "example_value",
        "status": "confirmed",
        "title": "Example Title"
      }
    ],
    "url_display_url": "https://example.com"
  }
}

Request

Response

Errors