Skip to main content

NoteStation

warning

This API is not documented yet.

Overview​

Interface for Synology NoteStation API.

Provides methods to interact with NoteStation features such as retrieving settings, notebooks, tags, shortcuts, todos, smart notes, and individual notes.

Methods​

settings_info​

Retrieve NoteStation settings information.

Internal API​

SYNO.NoteStation.Setting

Returns​

dict[str, object] or str
The API response containing settings information or an error message.


info​

Retrieve NoteStation general information.

Internal API​

SYNO.NoteStation.Info

Returns​

dict[str, object] or str
The API response containing general information or an error message.


notebooks_info​

Retrieve the list of notebooks.

Internal API​

SYNO.NoteStation.Notebook

Returns​

dict[str, object] or str
The API response containing the list of notebooks or an error message.


tags_info​

Retrieve the list of tags.

Internal API​

SYNO.NoteStation.Tag

Returns​

dict[str, object] or str
The API response containing the list of tags or an error message.


shortcuts​

Retrieve the list of shortcuts.

Internal API​

SYNO.NoteStation.Shortcut

Returns​

dict[str, object] or str
The API response containing the list of shortcuts or an error message.


todo​

Retrieve the list of todo items.

Internal API​

SYNO.NoteStation.Todo

Returns​

dict[str, object] or str
The API response containing the list of todo items or an error message.


smart​

Retrieve the list of smart notes.

Internal API​

SYNO.NoteStation.Smart

Returns​

dict[str, object] or str
The API response containing the list of smart notes or an error message.


note_list​

Retrieve the list of notes.

Internal API​

SYNO.NoteStation.Note

Returns​

dict[str, object] or str
The API response containing the list of notes or an error message.


specific_note_id​

Retrieve a specific note by its ID.

Internal API​

SYNO.NoteStation.Note

Parameters​

note_id str or int
The ID of the note to retrieve.

Returns​

dict[str, object] or str
The API response containing the note data or an error message.