List Sales (DataTable)
Retrieve a paginated list of sales/auctions.
GET
/datatable-sales
Query Parameters
| Parameter | Type | Description | Example |
|---|---|---|---|
range |
integer | Items per page | ?range=25 |
page |
integer | Page number | ?page=0 |
sort |
string | Sort field and direction | ?sort=-sale_date |
filter[status] |
string | Sale status (draft, published, closed) | ?filter[status]=published |
filter[sale_date][value][from] |
string | Min sale date | ?filter[sale_date][value][from]=2025-01-01 |
filter[sale_date][value][to] |
string | Max sale date | ?filter[sale_date][value][to]=2025-12-31 |
filter[catalog] |
string | Catalog ID | ?filter[catalog]=78 |
fields |
string | Specific fields | ?fields=id,label,status |
Example Request
GET /api/v1.0/datatable-sales?filter[status]=published&sort=-sale_date&range=25Response
{
"data": [
{
"id": "456",
"label": "Summer Auction 2025",
"sale_date": "2025-06-15T19:00:00Z",
"status": "published",
"catalog": {
"id": "78",
"label": "Summer 2025 Catalog"
},
"item_count": 250,
"consignment_count": 15,
"total_estimates": "250000.00",
"total_hammer_price": "280000.00",
"lots_locked": false,
"venue": "Main Auction House",
"created": "2025-03-01T10:00:00Z"
}
],
"count": 12
}