Skip to content

Get an inspection item

Safety module

GET/inspection-items/{id}inspectionItems.get

An item of an inspection template. Returns one inspection item with its `ETag`. A inspection item the caller may not see returns 404.

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

Path and query parameters

inspectionItems.get: Path and query parameters
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the inspection item.
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: InspectionItem

inspectionItems.get: InspectionItem
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the inspection item.
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.
inspection_template_idstring (uuid)YesIdentifier of the inspection template.
positionintegerYesItem order.Constraints: range 1 to any
promptstringYesWhat to check.Constraints: length 1 to 300
is_criticalbooleanYesWhether a failure of this item stops use.
{
  "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",
  "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "position": 1,
  "prompt": "Guardrails secured on all stage edges",
  "is_critical": true
}

Code samples

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