Luxor PlatformAPI DocumentationCommanderInventory

Get inventory assets

Returns a paginated list of inventory assets with filtering, search, and sorting. Set `archived=true` to return soft-deleted assets (the "Deleted miners" tab). For nested AND/OR logic, pass the `filter` query parameter as URL-encoded JSON; when supplied, it supersedes the flat filter params.

GET
/v2/commander/inventory/assets

Authorization

LuxorAPIKey
authorization<token>

Use your API key here.

In: header

Query Parameters

site_id?string
Formatuuid
lifecycle_status?string

Value in

  • "deployed"
  • "ready_to_deploy"
  • "in_repair"
  • "in_storage"
  • "retired"
client_id?string
Formatuuid
search?string
filter?

URL-encoded JSON advanced filter, shape { combinator: 'AND'|'OR', groups: [{ combinator, conditions: [{ field, operator, value }] }] }. Filterable fields: lifecycle_status, manufacturer, model, site_id, client_id, supplier, asset_code, serial_number, mac_address, external_id, acquisition_date, warranty_expiry. Operators: eq, ne, gt, lt, gte, lte, in_array, not_in_array, in_comma_separated_list, contains, not_contains. Supersedes the flat filter params (site_id, lifecycle_status, client_id) when supplied.

archived?boolean

When true, returns soft-deleted assets only. Default false.

Defaultfalse
sort_by?string

Value in

  • "asset_code"
  • "lifecycle_status"
  • "manufacturer"
  • "model"
  • "acquisition_date"
  • "created_at"
  • "updated_at"
sort_order?string
Default"asc"

Value in

  • "asc"
  • "desc"
page_number?integer
Range1 <= value
Default1
page_size?integer
Range1 <= value <= 5000
Default25

Response Body

application/json

application/json

application/json

curl -X GET "https://example.com/v2/commander/inventory/assets"
{  "assets": [    {      "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",      "asset_code": "WM-S21P-000001",      "mac_address": "AA:BB:CC:DD:EE:FF",      "serial_number": "SN-123456",      "manufacturer": "Bitmain",      "model": "S21 Pro",      "external_id": "ERP-0001",      "site_id": "b0a5fad8-1234-5678-9abc-def012345678",      "site_name": "Phoenix 1",      "lifecycle_status": "deployed",      "current_miner_id": "m-0001",      "client_id": "c1a2b3c4-...",      "location": {        "group_name": "Hall A",        "rack_name": "R-12",        "row": 3,        "column": 8      },      "acquisition_date": "2025-09-01",      "acquisition_cost": "2450.00",      "supplier": "Acme Distributors",      "warranty_expiry": "2027-09-01",      "custom_fields": {        "po_number": "PO-558"      },      "has_activity_conflict": false,      "created_at": "2025-09-02T09:30:00Z",      "updated_at": "2026-04-20T10:15:00Z",      "retirement_reason": "Damaged beyond repair",      "url": "/v2/commander/inventory/assets/a1b2c3d4-e5f6-7890-abcd-ef1234567890"    }  ],  "pagination": {    "page_number": 1,    "page_size": 1,    "item_count": 0,    "previous_page_url": null,    "next_page_url": null  }}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}
{  "statusCode": 400,  "code": "FST_ERR_VALIDATION",  "error": "Bad Request",  "message": "body/end_date Required"}