API Endpoints
Auto-generated - Do not edit manually.
Framework M exposes REST APIs for all DocTypes with api_resource = True.
Resource API
Base URL: /api/v1/resource/{DocType}
| Method | Endpoint | Description |
|---|---|---|
GET | /{DocType} | List records (paginated) |
GET | /{DocType}/{id} | Get single record |
POST | /{DocType} | Create record |
PUT | /{DocType}/{id} | Update record |
DELETE | /{DocType}/{id} | Delete record |
Query Parameters
| Parameter | Type | Description |
|---|---|---|
limit | int | Max records (default: 20, max: 1000) |
offset | int | Skip records |
order_by | str | Sort field (prefix - for desc) |
filters | JSON | Filter specs |
Filter Format
[
{"field": "status", "operator": "eq", "value": "Active"},
{"field": "amount", "operator": "gte", "value": 100}
]
Operators
| Operator | Description |
|---|---|
eq | Equals |
ne | Not equals |
gt | Greater than |
gte | Greater than or equal |
lt | Less than |
lte | Less than or equal |
like | Contains (SQL LIKE) |
in | In list |
is_null | Is null |
Meta API
| Endpoint | Description |
|---|---|
GET /api/v1/meta/{DocType} | Get DocType schema |
Returns JSON Schema for the DocType including:
- Field definitions
- Required fields
- Default values
- Validation rules