API Reference
Nid exposes a REST API via Fastify. All routes are prefixed with /api.
Interactive Swagger documentation is available in development at http://localhost:4000/docs.
Authentication
All routes (except /api/auth/config, /api/auth/register, /api/auth/login and OAuth callbacks) require an httpOnly JWT cookie.
Endpoints by module
| Module | Prefix | Documentation |
|---|---|---|
| Authentication | /api/auth | auth.md |
| Gmail | /api/gmail | gmail.md |
| Archives | /api/archive | archive.md |
| Dashboard | /api/dashboard | dashboard.md |
| Rules | /api/rules | rules.md |
| Jobs | /api/jobs | jobs.md |
| Notifications | /api/notifications | notifications.md |
| Webhooks | /api/webhooks | webhooks.md |
| Admin | /api/admin | admin.md |
| Audit | /api/audit | audit.md |
| Newsletters | /api/unsubscribe | unsubscribe.md |
| Attachments | /api/attachments | attachments.md |
| Duplicates | /api/duplicates | duplicates.md |
| Reports | /api/reports | reports.md |
| Integrity | /api/integrity | integrity.md |
| Configuration | /api/config | config.md |
| Privacy | /api/privacy | privacy.md |
| Analytics | /api/analytics | analytics.md |
| Saved searches | /api/saved-searches | saved-searches.md |
| Unified inbox | /api/unified | unified.md |
Health check
GET /healthReturns 200 OK if the service is operational.
Common response codes
| Code | Meaning |
|---|---|
200 | Success |
201 | Resource created |
202 | Accepted (async job created) |
400 | Validation error (Zod) |
401 | Not authenticated |
403 | Access denied (role or ownership) |
404 | Resource not found |
429 | Rate limit reached |
500 | Server error |