Skip to content

Get an asset class

Assets module

GET/asset-classes/{id}assetClasses.get

An asset class bound to a catalog element (class grain). Returns one asset class with its `ETag`. A asset class 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

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

assetClasses.get: AssetClass
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the asset class.
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.
namestringYesAsset class name.Constraints: length 1 to 300
element_idstringYesCanon element the class is.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
{
  "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",
  "name": "Truss Section 10 ft",
  "element_id": "5000.02.02-XPMS-003"
}

Code samples

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