PrimeCal Developer Docs
Code-Backed API Reference By Product Area
This section mirrors the actual product feature map. It documents the non-admin backend directly from the NestJS controllers and DTOs, with request constraints, auth notes, example calls, and implementation caveats.
Start Here
Overview
API Overview
Base path, auth modes, scope rules, and the full product-area map.
Authentication
Authentication API
Registration, onboarding, login, MFA, OAuth, refresh flow, and user API keys.
Profile
User API
Profile settings, language, workspace layout preferences, permission bootstrap, and sharing helpers.
Sharing
User Group API
People-group CRUD, invitation lifecycle, member roles, and group calendar assignment.
Automation
Automation API
Rules, triggers, conditions, actions, audit logs, approvals, and webhooks.
AI Agents
Agent API
Agent CRUD, scoped permissions, issued keys, and MCP runtime usage contracts.
MCP Runtime
MCP Server Architecture
Transports, tool/resource registration, adapter boundaries, auth model, and extension patterns.
Product Areas
Planning
Calendar, People Groups, Events, Tasks
Calendars, calendar groups, group sharing, event CRUD and recurrence, comments, task CRUD, and labels.
Integrations
External Sync
Provider status, OAuth handoff, external calendar mapping, disconnect, and manual sync.
User Controls
Notifications, Personal Logs, Compliance
Inbox and preferences, audit feed and summary, privacy exports, requests, and consents.
Scheduling Domain
Organizations, Resources, Booking
Organizations, roles, resources, reservation calendars, reservations, and public booking.
Platform
Platform API
Health, readiness, feature flags, monitoring, frontend error ingestion, and security reports.
Recommended Reading Path
- Read API Overview.
- Pick the product area that matches the user-facing feature you are building.
- Use the endpoint tables and DTO rules before wiring client requests.
- Treat anything under admin controllers as a separate documentation surface.
Swagger UI
When enabled by the backend, generated Swagger UI is served at /api/docs. Production deployments can place HTTP Basic authentication in front of that route.