NoteStation
This API is partially documented or under construction.
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.
notestation_settings_init​
Initialise NoteStation settings.
The API returns {"success": true} on completion. This is a
one-time setup operation — call it after installing NoteStation.
Internal API​
SYNO.NoteStation.Setting
Returns​
dict[str, object] or str
API response.
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_note_list​
Retrieve the list of smart notes.
Internal API​
SYNO.NoteStation.Smart
Parameters​
offset int
Pagination offset. Default 0.
limit int
Max items to return. Default 50.
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.
note_idle​
Put a note into idle state.
Internal API​
SYNO.NoteStation.Note
Parameters​
note_id str
The object_id of the note (from note_list()).
Returns​
dict[str, object] or str
API response.