Swush
API

REST Resources

Core REST endpoints for files, notes, snippets, bookmarks, shortlinks, recipes, and more.

All REST endpoints live under /api/v1.

Core resources

  • Files: /api/v1/files and /api/v1/upload
  • Notes: /api/v1/notes
  • Snippets: /api/v1/snippets
  • Bookmarks: /api/v1/bookmarks
  • Short links: /api/v1/shorten
  • Recipes: /api/v1/recipes

Tags

  • Bookmark tags: /api/v1/bookmark-tags
  • Recipe tags: /api/v1/recipe-tags
  • Shortlink tags: /api/v1/shortlink-tags
  • Snippet tags: /api/v1/snippet-tags
  • Note tags: /api/v1/note-tags

Public access

Public resources use the /p prefix per resource (for example /api/v1/notes/p/{slug} and /api/v1/snippets/p/{slug}).

Full schema

See the OpenAPI document at /api/v1/openapi for complete request/response details.

On this page