Get room booking installation settings

1 parameter

installation_idstringrequired

The unique identifier of the room booking installation whose settings you want to retrieve.

3 status codes

200Returns a `data` object containing the installation's settings, including booking options, display preferences, time format, time zone, and logo attachment status.

dataobjectoptional

401Returned when the request is unauthorized.

errorstringoptional

404Returned when the installation belongs to another user.

Error handling

A 401 is returned when the request is unauthorized. A 404 is returned when the installation_id path parameter belongs to another user.

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

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

const result = await client.settings.list({ installationId: "3fa85f64-5717-4562-b3fc-2c963f66afa6" });

{
  "data": {
    "color_company_logo_attached": true,
    "company_logo_attached": true,
    "daily_public_booking_url_rotation": true,
    "dark_mode": true,
    "public_bookings": true,
    "show_company_logo": true,
    "time_format": "null",
    "timezone": "Europe/Amsterdam",
    "walk_up_booking_window_days": "1",
    "walk_up_calendar": true
  }
}

Request

Response

Errors