API Reference

API is used by the outside requests to do something inside the database.

Base URL

All API requests should be prefixed with:

http://your-app-url.com/api

Response Format

All responses are returned in JSON format.

Success Response

{
    "data": { ... }
}

Error Response

{
    "message": "Resource not found",
    "errors": { ... } // Optional validation errors
}

Topics

• Records API: CRUD operations for Collection Records (List, View, Create, Update, Delete).
• Authentication API: Login, Registration, OTP, and Password Management.
• Realtime API: WebSockets interactions for real-time updates.

Common Headers

Header	Value	Description
Accept	application/json	Required. Ensures Laravel returns JSON responses instead of redirects.
Content-Type	application/json	Required for POST/PUT requests with JSON body.
Authorization	Bearer <token>	Required for authenticated endpoints.

Next up: Records API

---

Table of contents

• Records API
• Authentication
• Realtime