Skip to content

Get an asset unit

Assets module

GET/asset-units/{id}assetUnits.get

An individual asset tracked by serial or asset tag (unit grain), with a nine-value lifecycle. Returns one asset unit with its `ETag`. A asset unit 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

assetUnits.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset unit.
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: AssetUnit

assetUnits.get: AssetUnit
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset unit.
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.
asset_tagstringYesAsset tag (a code that is ours).Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
asset_state"Proposed" | "Received" | "Available" | "Reserved" | "Deployed" | "In Maintenance" | "Damaged" | "Lost" | "Retired"YesAsset lifecycle state.
condition_enum_idstring | nullYesCondition: a row of the canon Asset Condition enumeration.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
home_venue_idstring (uuid) | nullYesIdentifier of the venue the unit returns to.
{
  "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",
  "asset_tag": "NWL-TR-0042",
  "asset_state": "Available",
  "condition_enum_id": "ENM-017",
  "home_venue_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
}

Code samples

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