This page provides a quick reference of all available API endpoints. Click on any domain name to see its full documentation.
Before using any endpoint, read the Concepts section to understand authentication, envelope format, and pagination.
| Domain | Base path | Operations |
|---|
| Notes | /notes | CRUD, archive, custom fields |
| Events | /events | CRUD, recurrence, custom fields |
| Contacts | /contacts | CRUD, custom fields |
| Emails | /emails | CRUD, send, snooze, batch, read/star |
| Email Accounts | /email-accounts | CRUD, test connection, IMAP folders |
| Files & Drive | /files | Upload, mkdir, CRUD, preview, download |
| Photos | /photos, /albums | Timeline, search, albums, AI pipeline |
| Diary | /diary | CRUD, append, stats |
| Bookmarks | /bookmarks | CRUD, tags, domains, check-alive |
| Feeds (RSS) | /feeds | Subscribe, discover, articles, OPML |
| Search | /search | Cross-domain full-text and semantic search |
| Entity Links & Graph | /links, /graph | Cross-domain entity relationships |
| Kanban (Projects) | /kanban | Boards, columns, cards, labels, checklists |
| Diagrams | /diagrams | CRUD for diagram documents |
| Domain | Base path | Operations |
|---|
| Storage (HAL) | /storage | Volumes, SMART data, mount points |
| Network & Proxy | /network, /hal/network/proxy | Interfaces, reverse proxy, SSL |
| DNS | /dns | Zones, records, DDNS, providers |
| VPN | /wg-easy, /hal/network/tailscale | WireGuard, Tailscale |
| Processes | /hal/processes | Process manager |
| Managed Services | /portainer, /termix | Docker containers lifecycle |
All endpoints share these conventions:
- Authentication: Bearer token in
Authorization header (details)
- Envelope: Responses wrapped in
{ data } or { data, meta } (details)
- Pagination:
?limit= and ?offset= on all list endpoints (details)
- Compact format:
?format=compact for token-optimized responses (details)
- Soft deletes:
DELETE sets deleted_at, ?permanent=true for hard delete (details)