Get all available collections/schemas in Baasix with optional search and pagination

Get detailed schema information for a specific collection

Create a new collection schema in Baasix.

FIELD TYPES:

• String: VARCHAR with values.length (e.g., 255)

• Text: Unlimited text

• Integer, BigInt: Whole numbers

• Decimal: values.precision & values.scale

• Float, Real, Double: Floating point

• Boolean: true/false

• Date, DateTime, Time: Date/time

• UUID: With defaultValue.type: "UUIDV4"

• SUID: Short unique ID with defaultValue.type: "SUID"

• JSONB: JSON with indexing

• Array: values.type specifies element type

• Geometry, Geography: PostGIS spatial

• Enum: values.values array

DEFAULT VALUE TYPES:

• { type: "UUIDV4" } - Random UUID v4

• { type: "SUID" } - Short unique ID

• { type: "NOW" } - Current timestamp

• { type: "AUTOINCREMENT" } - Auto-incrementing integer

• { type: "SQL", value: "..." } - Custom SQL expression

• Static values: "active", false, 0, etc.

VALIDATION RULES:

• min: number - Minimum value (numeric fields)

• max: number - Maximum value (numeric fields)

• isInt: true - Must be integer

• notEmpty: true - String cannot be empty

• isEmail: true - Valid email format

• isUrl: true - Valid URL format

• len: [min, max] - String length range

• is/matches: "regex" - Pattern matching

SCHEMA OPTIONS:

• timestamps: true adds createdAt/updatedAt

• paranoid: true enables soft deletes (deletedAt)

EXAMPLE: { "name": "Product", "timestamps": true, "fields": { "id": {"type": "UUID", "primaryKey": true, "defaultValue": {"type": "UUIDV4"}}, "sku": {"type": "SUID", "unique": true, "defaultValue": {"type": "SUID"}}, "name": {"type": "String", "allowNull": false, "values": {"length": 255}, "validate": {"notEmpty": true}}, "price": {"type": "Decimal", "values": {"precision": 10, "scale": 2}, "validate": {"min": 0}}, "email": {"type": "String", "validate": {"isEmail": true}}, "quantity": {"type": "Integer", "defaultValue": 0, "validate": {"isInt": true, "min": 0}} } }

Update an existing collection schema

Delete a collection schema

Add an index to a collection schema

Remove an index from a collection schema

Create a relationship between collections.

RELATIONSHIP TYPES:

• M2O (Many-to-One): Creates foreign key with auto-index. products.category → categories

• O2M (One-to-Many): Virtual reverse of M2O. categories.products → products

• O2O (One-to-One): Creates foreign key with auto-index. user.profile → profiles

• M2M (Many-to-Many): Creates junction table with auto-indexed FKs. products ↔ tags

• M2A (Many-to-Any): Polymorphic junction table. comments → posts OR products

AUTO-INDEXING: All foreign key columns are automatically indexed for better query performance:

• M2O/O2O: Index on the FK column (e.g., category_Id)

• M2M/M2A: Indexes on both FK columns in junction tables

JUNCTION TABLES (M2M/M2A):

• Auto-generated name: {source}{target}{name}_junction

• Custom name: Use "through" property (max 63 chars for PostgreSQL)

• Junction tables are marked with isJunction: true in schema

EXAMPLE M2O: { "name": "category", // Creates category_Id field + index "type": "M2O", "target": "categories", "alias": "products", // Reverse relation name "onDelete": "CASCADE" // CASCADE, RESTRICT, SET NULL }

EXAMPLE M2M: { "name": "tags", "type": "M2M", "target": "tags", "alias": "products" }

EXAMPLE M2M with custom junction table: { "name": "tags", "type": "M2M", "target": "tags", "alias": "products", "through": "product_tag_mapping" // Custom junction table name }

Update an existing relationship

Delete a relationship

Export all schemas as JSON

Import schemas from JSON data

Query items from a collection with powerful filtering, sorting, pagination, relations, and aggregation.

FILTER OPERATORS (50+):

• Comparison: eq, neq, gt, gte, lt, lte

• String: contains, icontains, startswith, endswith, like, ilike, regex

• Null: isNull (true/false), empty (true/false)

• List: in, nin, between, nbetween

• Array: arraycontains, arraycontainsany, arraylength, arrayempty

• JSONB: jsoncontains, jsonhaskey, jsonhasanykeys, jsonhasallkeys, jsonpath

• Geospatial: dwithin, intersects, contains, within, overlaps

• Logical: AND, OR, NOT

DYNAMIC VARIABLES:

• $CURRENT_USER: Current user's ID

• $NOW: Current timestamp

• $NOW-DAYS_7: 7 days ago

• $NOW+MONTHS_1: 1 month from now

FILTER EXAMPLES:

• {"status": {"eq": "active"}}

• {"AND": [{"price": {"gte": 10}}, {"price": {"lte": 100}}]}

• {"tags": {"arraycontains": ["featured"]}}

• {"author_Id": {"eq": "$CURRENT_USER"}}

• {"category.name": {"eq": "Electronics"}} (relation filter)

Get a specific item by ID from a collection, optionally including related data

Create a new item in a collection

Update an existing item in a collection

Delete an item from a collection

List files with metadata and optional filtering

Get detailed information about a specific file

Delete a file

Check the current authentication status and token validity

Force refresh the authentication token (only works for email/password auth)

Generate reports with grouping and aggregation for a collection

Get collection statistics and analytics

List notifications for the authenticated user

Send a notification to specified users

Mark a notification as seen

Get application settings

Update application settings

List all email templates with optional filtering

Get a specific email template by ID

Update an email template's subject, description, or body content.

TEMPLATE TYPES:

• magic_link: Magic link authentication emails

• invite: User invitation emails

• password_reset: Password reset emails

• welcome: Welcome emails

• verification: Email verification emails

AVAILABLE VARIABLES:

• User: {{user.firstName}}, {{user.lastName}}, {{user.fullName}}, {{user.email}}

• Tenant: {{tenant.name}}, {{tenant.logo}}, {{tenant.website}}

• Auth: {{magicLink}}, {{magicCode}}, {{resetPasswordLink}}, {{inviteLink}}

• DateTime: {{currentDate}}, {{currentTime}}, {{currentYear}}

List all available roles

List all permissions with optional filtering

Get a specific permission by ID

Get permissions for a specific role

Create a new permission for role-based access control.

ACTIONS: create, read, update, delete

FIELDS:

• ["*"] for all fields

• ["name", "price"] for specific fields

CONDITIONS (Row-level security):

• Uses same filter operators as queries

• {"published": {"eq": true}} - only published records

• {"author_Id": {"eq": "$CURRENT_USER"}} - only own records

RELCONDITIONS (Filter related data):

• {"reviews": {"approved": {"eq": true}}} - only approved reviews in response

EXAMPLE: { "role_Id": "uuid", "collection": "products", "action": "read", "fields": ["*"], "conditions": {"published": {"eq": true}} }

Update an existing permission

Delete a permission

Reload the permission cache

Update permissions for a role

Get the status of the realtime service including WAL configuration.

Returns information about:

• Whether realtime is initialized and consuming WAL

• PostgreSQL replication configuration (wal_level, max_replication_slots)

• Publication and replication slot status

• Collections with realtime enabled

Check PostgreSQL replication configuration for WAL-based realtime.

Returns:

• walLevel: Should be 'logical' for realtime to work

• maxReplicationSlots: Number of available replication slots

• maxWalSenders: Number of WAL sender processes

• replicationSlotExists: Whether the baasix slot exists

• publicationExists: Whether the baasix publication exists

• tablesInPublication: List of tables currently in the publication

Get list of collections with realtime enabled and their action configurations

Enable realtime for a collection. Changes will be broadcast via WebSocket when data is modified.

The realtime config is stored in the schema definition and can include specific actions to broadcast.

Disable realtime for a collection

Get Baasix server information and health status

Sort items within a collection (move item before/after another)

Register a new user

Login user with email and password

Send an invitation to a user

Verify an invitation token

Send magic link or code for authentication

Get available tenants for the current user

Switch to a different tenant context

Logout the current user

Get current user information with role and permissions