Appearance
Pagination
All list endpoints (GET /rest/{domain}/{entity}) return paginated results.
Query Parameters
| Parameter | Default | Description |
|---|---|---|
page | 1 | Page number (1-based) |
limit | 15 | Items per page |
Example: GET /rest/product/product?page=2&limit=25
Response Format
List responses include a pagination object alongside the data array:
json
{
"success": true,
"data": [
{ "id": 1, "name": "..." },
{ "id": 2, "name": "..." }
],
"pagination": {
"current_page": 2,
"per_page": 25,
"total": 142,
"total_pages": 6,
"has_next": true,
"has_prev": true
}
}Single Entity Responses
GET /rest/{domain}/{entity}/{id} (show) and GET /rest/{domain}/{entity}/item (item) return a single object without pagination:
json
{
"success": true,
"data": {
"id": 1,
"name": "..."
}
}The item endpoint accepts the same filters as index but returns only the first matching entity.