---
title: "List calendar notes"
method: GET
path: "/shop/calendar-notes"
tags: ["CalendarNotes"]
---

# List calendar notes

`GET /shop/calendar-notes`

Returns a paginated list of `CalendarNote` objects for the given
site. Notes can be filtered by an exact date or a date range to
populate the calendar viewport.

Requires the `RESERVATIONS_VIEW` permission on the site.

## Query parameters

- `site_id` string, required
- `date` string, date
- `dateFrom` string, date
- `dateTo` string, date
- `page` integer
- `per_page` integer

## Response `200`

A paginated list of `CalendarNote` objects for the site.

- object
  - `data` CalendarNote[], required — The calendar notes on this page.
    - `id` string, object-id, required — Unique identifier for the note.
    - `site_id` string, uuid, required — ID of the site this note is attached to.
    - `body` string, required — The note text. Plain text only — line breaks are preserved but no markdown is rendered.
    - `date` string, date, required — The calendar date the note applies to, in `YYYY-MM-DD` format in the site's local timezone.
    - `created_by_id` string, uuid, nullable — ID of the user who created the note.
    - `created_by` object, nullable — Summary of the user who created the note, if known.
    - `updated_by_id` string, uuid, nullable — ID of the user who last updated the note.
    - `updated_by` object, nullable — Summary of the user who last updated the note, if any updates have been made.
    - `deleted_by_id` string, uuid, nullable — ID of the user who deleted the note, if it has been soft deleted. Usually null on live records.
    - `deleted_by` object, nullable — Summary of the user who deleted the note, if it has been soft deleted.
    - `created_at` string, date-time, required — ISO-8601 timestamp of when the note was created.
    - `updated_at` string, date-time, required — ISO-8601 timestamp of when the note was last updated.

## Other responses

- `401` — The user is unauthenticated
- `403` — The authenticated user does not have permission.

---

[API](https://skmtc.dev/try/apis/trybe-api.md) · [All operations](https://skmtc.dev/try/apis/trybe-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/try/trybe-api/revisions/f37f92702da5/schema)