Selegic CRM Docs
ServerRoutes & API

API Reference

Top-level routes and RPC exposure (how to add new endpoints).

Where to add routes

  • Add a routes/<Model>.ts file that exports a create<Model>Routes() function.
  • Re-export and attach the module in routes/index.ts.

Important routes

  • /api/v1/health — health check (text "OK").
  • /api/v1/* — feature routes (CRUD, Flows, Dynamic Objects, Extensions).
  • /cdn/extensions/* — static artifact serving for extensions (configured in app.ts).

Typed RPC

Frontend RPC clients use the Hono route types so adding a new route module will expose typed RPC until you update the routeTree.

Example: adding a new feature route

  1. Create crm/server/routes/MyFeature.ts with createMyFeatureRoutes().
  2. Import and .route("/", createMyFeatureRoutes()) in routes/index.ts.
  3. Update tests and add documentation under crm/docs/content/docs/server/routes/.

On this page