Skip to content

Get an asset maintenance

Assets module

GET/asset-maintenance/{id}assetMaintenanceEvents.get

A maintenance event for an asset unit. Returns one asset maintenance with its `ETag`. A asset maintenance 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

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

assetMaintenanceEvents.get: AssetMaintenance
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset maintenance.
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_unit_idstring (uuid)YesIdentifier of the asset unit.
performed_onstring (date)YesWhen the maintenance was done.
descriptionstringYesWhat was done.Constraints: length 1 to 20000
cost_minorinteger (int64) | nullYesMaintenance cost. Integer minor units of the resource currency; null means unpriced, never zero.
currency_codestring | nullYesISO 4217 currency code of every money field.Constraints: pattern ^[A-Z]{3}$
{
  "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_unit_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "performed_on": "2026-10-08",
  "description": "Replaced the spigots.",
  "cost_minor": 12000,
  "currency_code": "USD"
}

Code samples

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