Skip to main content

Notes - API Documentation

Overview

Notes endpoints let dashboard users create, read, and delete app-related notes used in the Notes UI and related workflows.

Endpoint Index

Access & Permissions

  • Save endpoint requires core create permission for the app (or global admin).
  • Read endpoint requires core read permission for the app(s) in scope.
  • Delete endpoint requires core delete permission for the app and note-level edit/delete eligibility.

Feature Behavior

  • Notes can be private or public (noteType).
  • Read results are permission-filtered by owner, public visibility, and explicit email sharing.
  • Public note edit/delete permissions still enforce ownership/admin checks.
Implementation details

Database Collections

CollectionPurpose
countly.notesStores note records (content, visibility, owner, timestamps, indicator).
countly.membersUsed to enrich notes list with note owner display names.