Likha ERP Documentation

Welcome to the Likha ERP documentation. This guide covers all available information for interacting with your Likha ERP instance.

Getting Started

• Configure Data Model - Create collections, fields, and relationships
• API Quickstart - Make your first API requests
• Authentication Quickstart - Register, login, and make authenticated requests
• Realtime Quickstart - Connect to realtime data with WebSockets
• Automation Quickstart - Create your first flow

Table of Contents

Core Concepts

• Data Model Setup - Create collections, fields, and relationships
• Computed Fields - Automatically calculate field values using templates and expressions
• Filters - Filter syntax, operators, and advanced features
• Query Parameters - Complete guide to all query parameters

Authentication API

• Login - Authenticate as a user
• Logout - Invalidate refresh token and end session
• List OAuth Providers - Get configured OAuth providers
• OAuth Login - Start OAuth flow with provider
• Request Password Reset - Send password reset email
• Reset Password - Set new password with token
• Refresh Token - Get new access token

Items API

• List Items - Retrieve multiple items from a collection
• Create Multiple Items - Create multiple items in bulk
• Delete Multiple Items - Delete multiple items at once
• Update Multiple Items - Update multiple items in bulk
• Create Item - Create a single item
• Singleton Operations - Retrieve and update singleton items
• Retrieve Item - Get a specific item by ID
• Delete Item - Delete a specific item
• Update Item - Update a specific item

Files API

• Files - Upload, access, and transform files

Automation API

• Flows - Event-driven data processing and task automation
• Triggers - Events and conditions that start flows
• Operations - Individual actions within a flow
• Data Chain - Understanding data flow between operations

Realtime API

• Realtime - WebSocket and GraphQL subscriptions for live data updates

Base URL

All API requests should be made to:

https://your-domain.com

Authentication

All API endpoints require authentication. Include your access token in the request headers:

Authorization: Bearer YOUR_ACCESS_TOKEN

Query Parameters

Many endpoints support the following query parameters:

Parameter	Type	Description
fields	array	Control which fields are returned in the response
limit	integer	Limit the number of objects returned
offset	integer	Skip a number of items when fetching data
sort	array	Sort results by specified fields (use - prefix for descending)
filter	object	Filter items by given conditions - see Filter Rules for complete syntax
search	string	Filter items containing the search query in any field
meta	string	Specify what metadata to return in the response
backlink	boolean	Retrieve relational items excluding reverse relations with wildcard fields

Response Format

All successful responses follow this structure:

{
  "data": {},
  "meta": {}
}

The meta object contains pagination and total count information when applicable.

---

Quick Start

Basic CRUD Operations (REST API)

All API requests are made using standard HTTP methods and JSON.

List items:

GET /items/articles?limit=10 HTTP/1.1
Host: your-domain.com
Authorization: Bearer YOUR_ACCESS_TOKEN

Create item:

POST /items/articles HTTP/1.1
Host: your-domain.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "title": "New Article"
}

Get single item:

GET /items/articles/1 HTTP/1.1
Host: your-domain.com
Authorization: Bearer YOUR_ACCESS_TOKEN

Update item:

PATCH /items/articles/1 HTTP/1.1
Host: your-domain.com
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "status": "published"
}

Delete item:

DELETE /items/articles/1 HTTP/1.1
Host: your-domain.com
Authorization: Bearer YOUR_ACCESS_TOKEN

For detailed documentation on each endpoint, click the links in the Table of Contents above.