Beyond the core CRM REST API, your BasicsOS server exposes additional /api/* endpoints. These use the same authentication methods (session cookies, Better Auth token, or Personal CRM API token).
These endpoints are product features that power the BasicsOS web UI. Not all are required for minimal CRM CRUD integrations. They are listed here so integrators know they exist.
Identity and auth
| Path | Description |
|---|
GET /api/me | Returns the currently authenticated user’s profile. |
/api/auth/* | Better Auth routes (login, logout, session management). |
Object configuration
| Path | Description |
|---|
GET /api/object-config | List CRM object definitions and favorites. |
PUT /api/object-config/:id | Update object configuration (display name, icon, etc.). |
Schema introspection
| Path | Description |
|---|
GET /api/schema/:tableName | Returns the schema for a given table — column names, types, and constraints. Use this to discover writable fields for any resource. |
curl https://your-app.up.railway.app/api/schema/contacts \
-H "Authorization: Bearer bos_crm_your_token_here"
Views
| Path | Description |
|---|
GET /api/views | List saved views (filtered/sorted list configurations). |
POST /api/views | Create a saved view. |
PUT /api/views/:id | Update a saved view. |
DELETE /api/views/:id | Delete a saved view. |
Custom field definitions
| Path | Description |
|---|
GET /api/custom_field_defs | List custom field definitions across objects. |
POST /api/custom_field_defs | Create a custom field definition. |
PUT /api/custom_field_defs/:id | Update a custom field definition. |
DELETE /api/custom_field_defs/:id | Delete a custom field definition. |
Automation
| Path | Description |
|---|
GET /api/automation-runs | List automation execution history. |
Other product APIs
These endpoints power specific product features. They follow the same auth pattern.
| Path | Description |
|---|
/api/connections | Manage third-party provider connections. |
/api/gateway-chat | Proxy chat requests through the gateway. |
/api/threads | Conversation threads (chat/AI interactions). |
/api/meetings | Meeting records and scheduling data. |
/api/email-sync | Email synchronization status and configuration. |
/api/rbac | Role-based access control configuration. |
/api/admin | Administrative operations (user management, org settings). |
