Skip to content

Get an asset lot

Assets module

GET/asset-lots/{id}assetLots.get

A quantity of an asset class at a place (lot grain). Returns one asset lot with its `ETag`. A asset lot the caller may not see returns 404.

  • Requires the capability assets.asset.read.
  • OAuth scopes: assets.
  • Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.

Path and query parameters

assetLots.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset lot.
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$

Response 200: AssetLot

assetLots.get: AssetLot
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset lot.
org_idstring (uuid)YesIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)YesWhen the row was created.
created_bystring (uuid) | nullYesIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)YesWhen the row was last updated.
updated_bystring (uuid) | nullYesIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
asset_class_idstring (uuid)YesIdentifier of the asset class.
venue_idstring (uuid)YesIdentifier of the venue the lot sits at.
quantitynumberYesQuantity on hand.
on_handnumberYesQuantity on hand: the opening count plus the lot ledger.
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "asset_class_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "quantity": 36,
  "on_hand": 34
}

Code samples

curl -X GET "$XOS_BASE_URL/asset-lots/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
  -H "Authorization: Bearer $XOS_API_KEY"
const { data, etag } = await xos.assetLots.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");
response = xos.asset_lots.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")
xos asset-lots get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f