Welcome

This technical documentation maps each dispatchly. module to its backend implementation in tenant-api.

How to use this page

• Use the left sidebar to open a module tab.
• Each tab highlights key files (routes, controllers, services, schemas) and implementation notes.
• Use Swagger UI for exact request/response contracts and live testing.

Scope

The docs focus on current tenant backend behavior, permission guards, and module-level workflow integration.

Implementation-focused docs. Endpoints and permissions should still be validated in Swagger UI.

Swagger UI: Open Swagger

Implementation map

• Routes: tenant-api/src/modules/auth/routes.js
• Controller: tenant-api/src/modules/auth/controller.js (when present)
• Service: tenant-api/src/modules/auth/service.js
• Schemas/validation: tenant-api/src/modules/auth/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Auth API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/sse/routes.js
• Controller: tenant-api/src/modules/sse/controller.js (when present)
• Service: tenant-api/src/modules/sse/service.js
• Schemas/validation: tenant-api/src/modules/sse/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the SSE API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/users/routes.js
• Controller: tenant-api/src/modules/users/controller.js (when present)
• Service: tenant-api/src/modules/users/service.js
• Schemas/validation: tenant-api/src/modules/users/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Users API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/departments/routes.js
• Controller: tenant-api/src/modules/departments/controller.js (when present)
• Service: tenant-api/src/modules/departments/service.js
• Schemas/validation: tenant-api/src/modules/departments/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Departments API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/roles/routes.js
• Controller: tenant-api/src/modules/roles/controller.js (when present)
• Service: tenant-api/src/modules/roles/service.js
• Schemas/validation: tenant-api/src/modules/roles/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Roles API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/permissions/routes.js
• Controller: tenant-api/src/modules/permissions/controller.js (when present)
• Service: tenant-api/src/modules/permissions/service.js
• Schemas/validation: tenant-api/src/modules/permissions/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Permissions API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/admin/routes.js
• Controller: tenant-api/src/modules/admin/controller.js (when present)
• Service: tenant-api/src/modules/admin/service.js
• Schemas/validation: tenant-api/src/modules/admin/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Admin API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/leads/routes.js
• Controller: tenant-api/src/modules/leads/controller.js (when present)
• Service: tenant-api/src/modules/leads/service.js
• Schemas/validation: tenant-api/src/modules/leads/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Leads API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/quotes/routes.js
• Controller: tenant-api/src/modules/quotes/controller.js (when present)
• Service: tenant-api/src/modules/quotes/service.js
• Schemas/validation: tenant-api/src/modules/quotes/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Quotes API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/orders/routes.js
• Controller: tenant-api/src/modules/orders/controller.js (when present)
• Service: tenant-api/src/modules/orders/service.js
• Schemas/validation: tenant-api/src/modules/orders/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Orders API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/dispatch/routes.js
• Controller: tenant-api/src/modules/dispatch/controller.js (when present)
• Service: tenant-api/src/modules/dispatch/service.js
• Schemas/validation: tenant-api/src/modules/dispatch/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Dispatch API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/carriers/routes.js
• Controller: tenant-api/src/modules/carriers/controller.js (when present)
• Service: tenant-api/src/modules/carriers/service.js
• Schemas/validation: tenant-api/src/modules/carriers/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Carriers API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/invoices/routes.js
• Controller: tenant-api/src/modules/invoices/controller.js (when present)
• Service: tenant-api/src/modules/invoices/service.js
• Schemas/validation: tenant-api/src/modules/invoices/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Invoices API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/payments/routes.js
• Controller: tenant-api/src/modules/payments/controller.js (when present)
• Service: tenant-api/src/modules/payments/service.js
• Schemas/validation: tenant-api/src/modules/payments/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Payments API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/accounts/routes.js
• Controller: tenant-api/src/modules/accounts/controller.js (when present)
• Service: tenant-api/src/modules/accounts/service.js
• Schemas/validation: tenant-api/src/modules/accounts/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Accounts API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/marketing/routes.js
• Controller: tenant-api/src/modules/marketing/controller.js (when present)
• Service: tenant-api/src/modules/marketing/service.js
• Schemas/validation: tenant-api/src/modules/marketing/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Marketing API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/calendar/routes.js
• Controller: tenant-api/src/modules/calendar/controller.js (when present)
• Service: tenant-api/src/modules/calendar/service.js
• Schemas/validation: tenant-api/src/modules/calendar/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Calendar API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/notifications/routes.js
• Controller: tenant-api/src/modules/notifications/controller.js (when present)
• Service: tenant-api/src/modules/notifications/service.js
• Schemas/validation: tenant-api/src/modules/notifications/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Notifications API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/email-templates/routes.js
• Controller: tenant-api/src/modules/email-templates/controller.js (when present)
• Service: tenant-api/src/modules/email-templates/service.js
• Schemas/validation: tenant-api/src/modules/email-templates/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Email Templates API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/files/routes.js
• Controller: tenant-api/src/modules/files/controller.js (when present)
• Service: tenant-api/src/modules/files/service.js
• Schemas/validation: tenant-api/src/modules/files/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Files API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/search/routes.js
• Controller: tenant-api/src/modules/search/controller.js (when present)
• Service: tenant-api/src/modules/search/service.js
• Schemas/validation: tenant-api/src/modules/search/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Search API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/knowledge-base/routes.js
• Controller: tenant-api/src/modules/knowledge-base/controller.js (when present)
• Service: tenant-api/src/modules/knowledge-base/service.js
• Schemas/validation: tenant-api/src/modules/knowledge-base/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Knowledge Base API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/ai-pricing/routes.js
• Controller: tenant-api/src/modules/ai-pricing/controller.js (when present)
• Service: tenant-api/src/modules/ai-pricing/service.js
• Schemas/validation: tenant-api/src/modules/ai-pricing/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the AI Pricing API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/analytics/routes.js
• Controller: tenant-api/src/modules/analytics/controller.js (when present)
• Service: tenant-api/src/modules/analytics/service.js
• Schemas/validation: tenant-api/src/modules/analytics/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Analytics API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/templates/routes.js
• Controller: tenant-api/src/modules/templates/controller.js (when present)
• Service: tenant-api/src/modules/templates/service.js
• Schemas/validation: tenant-api/src/modules/templates/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Templates API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/settings/routes.js
• Controller: tenant-api/src/modules/settings/controller.js (when present)
• Service: tenant-api/src/modules/settings/service.js
• Schemas/validation: tenant-api/src/modules/settings/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Settings API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Implementation map

• Routes: tenant-api/src/modules/customers/routes.js
• Controller: tenant-api/src/modules/customers/controller.js (when present)
• Service: tenant-api/src/modules/customers/service.js
• Schemas/validation: tenant-api/src/modules/customers/schemas.js (when present)
• DB models: tenant-api/src/database/models (Sequelize)

Permissions

This module is protected via app.permissionGuard('<permission.key>') using keys defined in the tenant seeders. Validate required permissions and exact payload shapes in Swagger UI.

Notes

• Multi-tenant behavior is enforced via the tenant DB connection and auth guards.
• Models generally use snake_case DB columns with Sequelize field mappings.

Swagger UI: Open Swagger

How it works

These docs map the Customers API surface to your backend implementation. For exact request/response shapes, use Swagger UI.

Common backend patterns

• Routes are registered in tenant-api/src/modules/<module>/routes.js.
• Request validation is enforced in module-level schemas (Zod), plus middleware/guards at the route layer.
• Tenant isolation is handled via the tenant DB connection and auth guards.
• Most list endpoints follow the shared pagination pattern in tenant-api/src/common/pagination-schema.js.

Permission model

All module endpoints are protected with app.permissionGuard('<permission.key>') using keys defined in tenant seeders.

Customers linking behavior

• Customers are created/updated by email when Leads, Quotes, or Orders are created/updated (see findOrCreateCustomer in tenant-api/src/modules/customers/utils.js).
• Once a customer exists, their details are synced and downstream records store the customer_id (and Quotes also store customer_email).
• Use the Customer list stats to see leadsCount, quotesCount, and ordersCount aggregations.