API Documentation
RESTful API documentation for developers
https://api.lotsnotes.comAPI Key (Bearer token or X-API-Key header)
113
Authentication
All API requests require authentication using an API key. You can create an API key from your dashboard.
curl -H "Authorization: Bearer YOUR_API_KEY" \
https://api.lotsnotes.com/api/v1/lotsnotes/invitations/acceptworkspace_context
/api/v1/lotsnotes/invitations/acceptAccept invitation
lotsnotes_accept_invitationAccept an email-bound LotsNotes invitation.
/api/v1/lotsnotes/organizations/:organization_id/invitations/:invitation_idCancel invitation
lotsnotes_cancel_invitationCancel a pending invitation.
/api/v1/lotsnotes/organization-notesCreate organization note
lotsnotes_create_organization_noteCreate shared organization-wide text or checklist knowledge.
/api/v1/lotsnotes/organizations/:organization_id/invitationsInvite team member
lotsnotes_invite_memberEmail a secure LotsNotes team invitation.
/api/v1/lotsnotes/organizations/:organization_id/invitationsList invitations
lotsnotes_list_invitationsList organization invitations.
/api/v1/lotsnotes/organizations/:organization_id/contextList organization context
lotsnotes_get_organization_contextList organization-wide shared knowledge titles. Private notes are never returned.
/api/v1/lotsnotes/notes/:note_id/moveMove note
lotsnotes_move_noteMove a note between organization knowledge and projects in the same organization.
/api/v1/lotsnotes/organizations/:organization_id/invitations/:invitation_id/resendResend invitation
lotsnotes_resend_invitationSend a fresh invitation link.
/api/v1/lotsnotes/projects/:project_idUpdate project
lotsnotes_update_projectRename or describe a LotsNotes project.
/api/v1/lotsnotes/organizations/:organization_id/members/:member_idUpdate team member
lotsnotes_update_memberChange a member role and project access.
blocks
/api/v1/lotsnotes/blocksAdd Block
lotsnotes_add_blockAdd a content block to a note. For checklist blocks, ideally provide items with id, text, and checked fields. However, the API is forgiving - if you send just [{text: "task"}] or even ["task1", "task2"], it will auto-generate unique IDs and set checked=false. Example: {items: [{text: "Task 1"}, {text: "Task 2"}]}
/api/v1/lotsnotes/checklist-itemsAdd Checklist Item
lotsnotes_add_checklist_itemAdd a new item to an existing checklist block. The item will be added at the end of the list, unchecked.
/api/v1/lotsnotes/block/:idDelete Block
lotsnotes_delete_blockDelete a content block from a note. This permanently removes the block.
/api/v1/lotsnotes/blocks/:block_id/items/:item_idDelete Checklist Item
lotsnotes_delete_checklist_itemRemove a specific item from a checklist block.
/api/v1/lotsnotes/notes/:id/blocksGet Blocks
lotsnotes_get_blocksGet all content blocks for a note, ordered by position. This returns the full content of a note broken down into its component blocks.
/api/v1/lotsnotes/notes/:id/blocks/reorderReorder Blocks
lotsnotes_reorder_blocksChange the order of blocks within a note. Provide an array of block IDs with their new positions.
/api/v1/lotsnotes/block/:idUpdate Block
lotsnotes_update_blockUpdate a block's content or position. For checklist blocks, ideally provide items with id, text, and checked fields. However, the API is forgiving - missing id/checked will be auto-filled.
/api/v1/lotsnotes/blocks/:block_id/items/:item_idUpdate Checklist Item
lotsnotes_update_checklist_itemCheck or uncheck a specific item in a checklist block. Use this to mark tasks as complete or incomplete.
labels
/api/v1/lotsnotes/notes/:id/labelsAdd Label to Note
lotsnotes_add_label_to_noteAttach a label to a note for organization. A note can have multiple labels.
/api/v1/lotsnotes/notes/:id/labels/bulkBulk Add Labels to Note
lotsnotes_bulk_add_labels_to_noteAdd multiple labels to a note at once. Skips labels that are already attached.
/api/v1/lotsnotes/labelCreate Label
lotsnotes_create_labelCreate a new label for organizing notes. Labels can have a name and optional color. Label names must be unique per user.
/api/v1/lotsnotes/label/:idDelete Label
lotsnotes_delete_labelDelete a label. This will also remove the label from all notes that have it.
/api/v1/lotsnotes/label/:idGet Label
lotsnotes_get_labelGet a single label by ID.
/api/v1/lotsnotes/notes/:id/labelsGet Labels for Note
lotsnotes_get_labels_for_noteGet all labels attached to a specific note.
/api/v1/lotsnotes/labels/:id/notesGet Notes by Label
lotsnotes_get_notes_by_labelGet all notes that have a specific label attached. Useful for viewing notes in a category.
/api/v1/lotsnotes/labelsList Labels
lotsnotes_list_labelsList all labels for the user. Labels are sorted alphabetically by name. Supports search and pagination.
/api/v1/lotsnotes/notes/:note_id/labels/:label_idRemove Label from Note
lotsnotes_remove_label_from_noteRemove a label from a note.
/api/v1/lotsnotes/notes/:id/labelsSet Labels for Note
lotsnotes_set_labels_for_noteReplace all labels on a note with a new set. Removes existing labels and adds the specified ones.
/api/v1/lotsnotes/label/:idUpdate Label
lotsnotes_update_labelUpdate a label's name or color. Name must remain unique among user's labels.
project_context
/api/v1/lotsnotes/organizations/:organization_id/membersAdd organization member
lotsnotes_add_memberAdd an existing LotsNotes user to an organization.
/api/v1/lotsnotes/projectsCreate project
lotsnotes_create_projectCreate a project in a LotsNotes organization. Owner or admin required.
/api/v1/lotsnotes/project-notesCreate project note
lotsnotes_create_project_noteCreate a project-visible freeform text or checklist note.
/api/v1/lotsnotes/workspace/ensureEnsure workspace
lotsnotes_ensure_workspaceCreate the authenticated user's default LotsNotes organization and project when needed.
/api/v1/lotsnotes/project-notes/:note_idGet project note
lotsnotes_get_project_noteGet one project-visible note with its text or checklist blocks. Private notes return not found.
/api/v1/lotsnotes/organizations/:organization_id/membersList organization members
lotsnotes_list_membersList active LotsNotes organization members.
/api/v1/lotsnotes/projects/:project_id/contextList project context notes
lotsnotes_get_project_contextList inherited organization knowledge and project-specific shared note titles. Private notes are never returned.
/api/v1/lotsnotes/projectsList projects
lotsnotes_list_projectsList accessible projects in a LotsNotes organization.
/api/v1/lotsnotes/organizations/:organization_id/members/:member_idRemove organization member
lotsnotes_remove_memberRemove a member from a LotsNotes organization.
/api/v1/lotsnotes/project-notes/:note_idUpdate project note
lotsnotes_update_project_noteUpdate the title or note type of a project-visible note. Use update_block for its content.
business_context
/api/v1/lotsnotes/context/notes/:note_id/archiveArchive context note
lotsnotes_archive_context_noteArchive a note without deleting it.
/api/v1/lotsnotes/foldersCreate folder
lotsnotes_create_folderCreate a folder in a workspace, for a product, client, brand, agent or anything else. Set parent_folder_id to create it inside another folder.
/api/v1/lotsnotes/spacesCreate knowledge space
lotsnotes_create_spaceCreate a space inside an organization. A space can represent a product, project, brand, client, department, or initiative.
/api/v1/lotsnotes/context/notesCreate note
lotsnotes_create_context_noteCreate a shared note with a Markdown body and/or checklist items. Omit folder_id for a workspace-wide note. Title it AGENTS.md for instructions every agent should read. The response includes the note's url: give it to the person so they can open and review the note on lotsnotes.com.
/api/v1/lotsnotes/organizationsCreate organization
lotsnotes_create_organizationCreate an organization as the top-level business and team boundary.
/api/v1/lotsnotes/workspacesCreate workspace
lotsnotes_create_workspaceCreate a workspace for a business, team or area of work.
/api/v1/lotsnotes/folders/:folder_idDelete folder
lotsnotes_delete_folderDelete a folder that has no subfolders. Its notes are hidden and preserved, and restore_folder brings everything back.
/api/v1/lotsnotes/spaces/:space_idDelete knowledge space
lotsnotes_delete_spaceRecoverably delete a space. Its notes are hidden and preserved; they are never moved into broader organization knowledge.
/api/v1/lotsnotes/connections/:connection_idDisconnect an app
lotsnotes_revoke_connectionRevoke one connection. The app's token stops working immediately.
/api/v1/lotsnotes/contextFind notes
lotsnotes_find_contextFind shared notes by title. Workspace-wide notes always come back (as workspace_notes). With folder_id, that folder's own notes come back too (as folder_notes). Each note has a summary and a url. Read a note with read_note. A note titled AGENTS.md holds instructions for agents: read it first.
/api/v1/lotsnotes/context/notes/importImport context documents
lotsnotes_import_contextCreate or update labeled notes from a client's existing context documents. Idempotent on import_key.
/api/v1/lotsnotes/connectionsList connected apps
lotsnotes_list_connectionsList the apps this person has authorized to reach their notes.
/api/v1/lotsnotes/foldersList folders
lotsnotes_list_foldersList the folders in a workspace with their paths (e.g. "Agents / Blog / Drafts") and parent_folder_id.
/api/v1/lotsnotes/spacesList knowledge spaces
lotsnotes_list_spacesList active spaces for products, projects, brands, clients, departments, or initiatives.
/api/v1/lotsnotes/context/notes/:note_id/versionsList note history
lotsnotes_list_context_versionsList saved versions of an accessible note, newest first.
/api/v1/lotsnotes/organizationsList organizations
lotsnotes_list_organizationsList the organizations whose business context this user can access.
/api/v1/lotsnotes/workspacesList workspaces
lotsnotes_list_workspacesList the workspaces you can access. A workspace holds workspace-wide notes and folders.
/api/v1/lotsnotes/context/notes/:note_idMove context note to trash
lotsnotes_trash_noteSoft-delete a note so it can be restored later.
/api/v1/lotsnotes/folders/:folder_id/moveMove folder
lotsnotes_move_folderMove a folder inside another folder of the same workspace. Omit parent_folder_id (or send null) to move it to the top level.
/api/v1/lotsnotes/context/notes/:note_id/moveMove note
lotsnotes_move_context_noteMove a note to another folder, or to another workspace (needs admin access in both). Omit folder_id to make it workspace-wide. The note keeps its id, url and version history.
/api/v1/lotsnotes/context/notes/:note_idRead note
lotsnotes_read_noteRead one accessible shared note. Returns content_markdown, structured checklist items and the note's url (share it when the person wants to open the note). Private notes always return not found.
/api/v1/lotsnotes/context/versions/:version_idRead note version
lotsnotes_get_context_versionRead a saved version snapshot for an accessible note.
/api/v1/lotsnotes/folders/:folder_idRename folder
lotsnotes_update_folderRename a folder or change its description.
/api/v1/lotsnotes/organizations/:organization_idRename organization
lotsnotes_update_organizationRename an organization without changing its stable ID.
/api/v1/lotsnotes/workspaces/:workspace_idRename workspace
lotsnotes_update_workspaceRename a workspace. Its id does not change.
/api/v1/lotsnotes/context/resolveResolve bound context
lotsnotes_resolve_contextAssemble the core context for a bound scope into two prompt slots, plus a catalogue of the other notes available on demand.
/api/v1/lotsnotes/context/notes/:note_id/restoreRestore context note
lotsnotes_restore_context_noteRestore an archived or trashed note.
/api/v1/lotsnotes/folders/:folder_id/restoreRestore folder
lotsnotes_restore_folderRestore a deleted folder and its notes.
/api/v1/lotsnotes/spaces/:space_id/restoreRestore knowledge space
lotsnotes_restore_spaceRestore a recoverably deleted space and its preserved notes.
/api/v1/lotsnotes/context/notes/:note_id/versions/:version_id/restoreRestore note version
lotsnotes_restore_context_versionRestore an accessible note to a saved version while preserving the current state in history.
/api/v1/lotsnotes/context/notes/:note_idSave note
lotsnotes_save_context_noteSave a note title, Markdown body, or checklist in one coherent operation and create one version snapshot. The response includes the note's url: give it to the person so they can open and review the change on lotsnotes.com.
/api/v1/lotsnotes/spaces/:space_idUpdate knowledge space
lotsnotes_update_spaceRename or describe a knowledge space.
notes
/api/v1/lotsnotes/notes/:id/archiveArchive Note
lotsnotes_archive_noteArchive a note to remove it from the main view while keeping it accessible. Archived notes are automatically unpinned. Use list_notes with is_archived=true to view archived notes.
/api/v1/lotsnotes/notes/full/batchBatch get notes with blocks
lotsnotes_get_notes_full_batchFetch multiple notes with blocks by IDs in one request.
/api/v1/lotsnotes/notes/:id/colorChange Note Color
lotsnotes_change_note_colorChange the background color of a note for visual organization. Set to null to remove color.
/api/v1/lotsnotes/noteCreate Note
lotsnotes_create_noteCreate a new note with optional content blocks. For checklist notes, ideally provide items with id, text, and checked fields. However, the API is forgiving - if you send just [{text: "task"}] or even ["task1", "task2"], it will auto-generate unique IDs and set checked=false. Example: {block_type: "checklist", data: {items: [{text: "Buy groceries"}, {text: "Call mom"}]}}
/api/v1/lotsnotes/note/:idDelete Note
lotsnotes_delete_noteMove a note to trash (soft delete). The note can be restored later using restore_note or permanently deleted using permanently_delete_note.
/api/v1/lotsnotes/notes/:id/duplicateDuplicate Note
lotsnotes_duplicate_noteCreate a copy of an existing note including all its blocks and labels. The new note will have "(Copy)" appended to its title and will not be pinned.
/api/v1/lotsnotes/trashEmpty Trash
lotsnotes_empty_trashPermanently delete all notes in the trash. This action cannot be undone. All associated data (blocks, labels, reminders, versions) will be deleted.
/api/v1/lotsnotes/note/:idGet Note
lotsnotes_get_noteGet a single note by ID. Returns the note metadata without blocks. Use get_note_with_blocks for full content.
/api/v1/lotsnotes/notes/:id/fullGet Note With Blocks
lotsnotes_get_note_with_blocksGet a note with all its content blocks and optionally labels. This is the recommended way to read a note's full content. Blocks are returned in position order.
/api/v1/lotsnotes/trashGet Trash
lotsnotes_get_trashList all notes in the trash (soft-deleted notes). These notes can be restored using restore_note or permanently deleted.
/api/v1/lotsnotes/notesList Notes
lotsnotes_list_notesList all notes for the user with powerful filtering options. Filter by archived status, pinned status, label, note type, or color. Search notes by title. Results are sorted with pinned notes first, then by the specified sort field. Supports pagination for large collections.
/api/v1/lotsnotes/notes/fullList notes with blocks
lotsnotes_list_notes_fullList notes with blocks (and optional labels) in a single request.
/api/v1/lotsnotes/notes/:id/permanentPermanently Delete Note
lotsnotes_permanently_delete_notePermanently delete a note and all its associated data (blocks, labels, reminders, versions). This action cannot be undone. Use with caution.
/api/v1/lotsnotes/notes/:id/pinPin Note
lotsnotes_pin_notePin a note to the top of the list for quick access. Pinned notes always appear before unpinned notes when listing. Cannot pin archived notes.
/api/v1/lotsnotes/notes/:id/restoreRestore Note
lotsnotes_restore_noteRestore a note from archive or trash back to active status. Works for both archived notes and soft-deleted (trashed) notes.
/api/v1/lotsnotes/notes/:id/unpinUnpin Note
lotsnotes_unpin_noteRemove the pin from a note so it returns to normal sorting order.
/api/v1/lotsnotes/note/:idUpdate Note
lotsnotes_update_noteUpdate a note's metadata including title, type, color, and pinned status. This does not modify blocks - use block-specific tools for content changes.
reminders
/api/v1/lotsnotes/reminders/:id/cancelCancel Reminder
lotsnotes_cancel_reminderCancel an active reminder without deleting it.
/api/v1/lotsnotes/reminderCreate Reminder
lotsnotes_create_reminderSet a reminder for a note. The reminder will trigger at the specified time. Supports recurring reminders with repeat rules (daily, weekly, monthly, yearly).
/api/v1/lotsnotes/reminder/:idDelete Reminder
lotsnotes_delete_reminderDelete a reminder permanently.
/api/v1/lotsnotes/reminders/overdueGet Overdue Reminders
lotsnotes_get_overdue_remindersGet all active reminders that are past their scheduled time. These need attention.
/api/v1/lotsnotes/reminder/:idGet Reminder
lotsnotes_get_reminderGet details of a specific reminder including the associated note information.
/api/v1/lotsnotes/notes/:id/remindersGet Reminders for Note
lotsnotes_get_reminders_for_noteGet all reminders associated with a specific note.
/api/v1/lotsnotes/reminders/upcomingGet Upcoming Reminders
lotsnotes_get_upcoming_remindersGet active reminders scheduled within the next N hours (default 24). Useful for showing what's coming up soon.
/api/v1/lotsnotes/remindersList Reminders
lotsnotes_list_remindersList all reminders for the user. Filter by note, status, or date range. Sorted by reminder time.
/api/v1/lotsnotes/reminders/:id/doneMark Reminder Done
lotsnotes_mark_reminder_doneMark a reminder as completed/done.
/api/v1/lotsnotes/reminders/:id/snoozeSnooze Reminder
lotsnotes_snooze_reminderReschedule a reminder to a later time. The reminder will be reactivated at the new time.
/api/v1/lotsnotes/reminder/:idUpdate Reminder
lotsnotes_update_reminderUpdate a reminder's time, repeat rule, timezone, or status.
versions
/api/v1/lotsnotes/versions/compareCompare Versions
lotsnotes_compare_versionsCompare two versions of a note to see what changed between them.
/api/v1/lotsnotes/notes/:id/versions/latestGet Latest Version
lotsnotes_get_latest_versionGet the most recent saved version of a note.
/api/v1/lotsnotes/version/:idGet Version
lotsnotes_get_versionGet a specific version including its full snapshot data.
/api/v1/lotsnotes/versionsList Versions
lotsnotes_list_versionsList all saved versions of a note. Versions are sorted newest first.
/api/v1/lotsnotes/versions/:id/restoreRestore Version
lotsnotes_restore_versionRestore a note to a previous version. The current state is automatically saved as a new version before restoring, allowing you to undo the restore if needed.
/api/v1/lotsnotes/notes/:id/versionsSave Current Version
lotsnotes_save_current_versionCreate a version snapshot of the note's current state. Useful before making significant changes to enable undo.
attachments
/api/v1/lotsnotes/attachmentCreate Attachment
lotsnotes_create_attachmentCreate an attachment record for a file that has been uploaded to storage. The actual file upload should be done separately. Attachments can be linked to a specific block or to the note directly.
/api/v1/lotsnotes/attachment/:idDelete Attachment
lotsnotes_delete_attachmentDelete an attachment record. Returns the storage path so the actual file can be deleted from storage separately.
/api/v1/lotsnotes/attachment/:idGet Attachment
lotsnotes_get_attachmentGet details of a specific attachment including metadata.
/api/v1/lotsnotes/storage/usageGet Storage Usage
lotsnotes_get_storage_usageGet the user's total storage usage across all attachments. Shows total size in bytes and MB, file counts by type.
/api/v1/lotsnotes/attachmentsList Attachments
lotsnotes_list_attachmentsList all attachments for a note. Can filter by block or file type.
billing
/api/v1/lotsnotes/planGet LotsNotes plan
lotsnotes_get_planShow the caller's LotsNotes plan (Free or Pro), where Pro comes from, the Free limits (1 organization, 3 spaces, no team members) and current use.
/api/v1/lotsnotes/checkoutUpgrade to LotsNotes Pro
lotsnotes_create_checkoutStart a checkout for LotsNotes Pro ($99 once: unlimited organizations, spaces and team members). Returns a link for the person to pay in their browser. Pro is already included with Pro or Business plans of LotsSocial, LotsBlog or LotsTeam.
workspace
/api/v1/lotsnotes/projects/:project_id/moveMove folder (website)
lotsnotes_move_projectWebsite endpoint: put a folder inside another folder or at the top level.