List the bookings of a calendar

5 parameters

installation_idstringrequired

Room booking installation id

idstringrequired

Calendar id

fromstringoptional

Window start; now when left out

tostringoptional

Window end; seven days after from when left out

statusstringoptional

confirmed when left out: * `confirmed` * `cancelled`

Allowed:confirmedcancelled

4 status codes

200Success

dataarray<object>optional

401Unauthorized

errorstringoptional

404Installation belongs to another user

422A window that ends before it starts

Error handling

A 401 is returned: Unauthorized. A 404 is returned: Installation belongs to another user. A 422 is returned: A window that ends before it starts.

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

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

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

{
  "data": [
    {
      "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"
    }
  ]
}

Request

Response

Errors