API Routes Reference

← Back to Documentation Home

This document provides a comprehensive reference of all available API routes in BAASIX.

Authentication Routes

Notification Routes

Settings Routes

Item Routes

Reports Routes

File Routes

Schema Routes

Permission Routes

Utils Routes

Workflow Routes

Documentation Routes

Query Parameter Reference

All list endpoints (GET requests that return multiple items) support the following query parameters:

For more details on query parameters, see the Item Query Reference Guide.

Authentication

Most endpoints require authentication using one of these methods:

JWT Authentication

Add an Authorization header with a Bearer token:

Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR...

Cookie Authentication

If cookie authentication is enabled, session cookies are automatically handled after login.

Response Format

All API responses follow a consistent structure:

Success Response

{
  "data": {
    // Response data here
  }
}

For collection endpoints:

{
  "data": [
    // Array of items
  ],
  "totalCount": 42
}

Error Response

{
  "error": {
    "message": "Error message here",
    "code": "ERROR_CODE",
    "details": {}
  }
}

HTTP Status Codes

Rate Limiting

API requests are subject to rate limiting to prevent abuse. The following headers are included in responses:

• X-RateLimit-Limit: Maximum number of requests allowed in the time window
• X-RateLimit-Remaining: Number of requests remaining in the current time window
• X-RateLimit-Reset: Time when the rate limit resets (Unix timestamp)

If you exceed the rate limit, you'll receive a 429 Too Many Requests response.

Related Documentation

• Authentication Routes - Detailed auth endpoints documentation
• Notification Routes - User notification management
• Settings Routes - Application configuration management
• Schema Routes - Schema management endpoints
• Item Routes - Data CRUD operations
• Reports Routes - Analytics and reporting with aggregation
• File Routes - File management endpoints
• Utils Routes - Utility operations like sorting
• Deployment Guide - Production deployment instructions

← Back to Documentation Home