This page indexes the per-module endpoint documentation. Each module's overview lists its endpoints in detail with parameters and examples. Use this as a quick lookup; follow the link to the module page for the full surface.
Auth and identity
| Module | Surface | Doc |
|---|---|---|
| Users (sign-in, OAuth, magic link) | /profile/* and /user/* (both registered on the users controller) | Authentication |
| API keys | /api-key/* | Authentication |
| Org management | /org-management/* | Org management |
Data and content
| Module | Surface | Doc |
|---|---|---|
| Repository (CRUD) | /repository/* | Data layer |
| Dynamic query | /mongodb/* and /dynamic-query/* (both registered on the same controller) | Data layer |
| Sites and pages | /site/* | Site and deployment |
Commerce
| Module | Surface | Doc |
|---|---|---|
| Storefront catalogue + cart | /storefront/* | Commerce overview |
| Discounts | /storefront/discounts/* | Discounts and promo codes |
| Gift cards | /storefront/giftcards/* | Gift cards |
| Inventory | /storefront/inventory/* | Inventory |
| Shipping and tax | /shipping/*, /storefront/tax/* | Shipping and tax |
| Returns | /storefront/returns/* | Returns and RMA |
| Rentals | /storefront/rental/* | Subscriptions and rentals |
| Invoices | /storefront/invoices/* | Invoicing |
CRM
| Module | Surface | Doc |
|---|---|---|
| Contacts and forms | /crm/*, /crm/contact-form/* | CRM overview |
| Leads and pipelines | /crm/leads/* | Tasks and opportunities |
| Marketing campaigns | /crm/marketing/* | Marketing campaigns |
| Audiences | /crm/marketing/audiences/* | Audiences and segmentation |
| Ads | /crm/ads/* | Ads management |
| Events / reservations / tickets | /crm/events/*, /crm/reservations/*, /crm/tickets/* | Events, reservations, and tickets |
| Activity log | /crm/activity/* | Activities and audit |
| Promotions | /crm/promotions/* | Promotions and subscriptions |
| Merchant customer | /crm/merchant-customers/* | Merchant customer |
Finance, banking, and money
| Module | Surface | Doc |
|---|---|---|
| Finance / payouts | /finance/* | Finance overview |
| Banking-as-a-service | /banking/* | Banking |
Integrations
| Module | Surface | Doc |
|---|---|---|
| Upstream (vendor calls) | /upstream/* | Integrations overview |
| Connect (OAuth + webhooks) | /connect/* | OAuth flow |
| Per-vendor guides | per-vendor | Vendor guides |
Customer-facing API
| Module | Surface | Doc |
|---|---|---|
| Customer account | /client-data/* | Customer account |
| Customer storefront | /storefront/* (auth) | Customer storefront |
| Customer community | /client/community/* | Customer community |
| Customer events | /client/events/* | Customer events |
| Customer logistics | /client/logistics/* | Customer logistics |
| Customer wallet | /client/finance/* | Customer finance and wallet |
Operational
| Module | Surface | Doc |
|---|---|---|
| Sync and background jobs | /sync/* | Sync and jobs |
| Usage and pricing | /usage/* | Usage and pricing |
| Monitoring | /monitoring/* | Monitoring |
| Client apps | /client-app/* | Client apps |
Auth header rules
Every request needs:
orgidheader — your tenantAuthorization: Bearer <jwt>for staff or customer auth, ORx-api-key: <key>for service-to-service
Public endpoints listed in module docs accept calls without the JWT but still require orgid.
Versioning
The API is currently at v1. There is no /v1/ URL prefix; if and when v2 ships, breaking changes will get a parallel path. Check the release notes (TBD) for current API status.
OpenAPI
Each controller is decorated with @nestjs/swagger annotations. The platform exposes the OpenAPI spec at /api-docs (when enabled in the configured deployment). Use it as a machine-readable reference alongside the prose docs here.