Skip to content

Get an inspection

Safety module

GET/inspections/{id}inspections.get

An inspection performed from a template, with sign-off. Returns one inspection with its `ETag`. A inspection 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

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

inspections.get: Inspection
FieldTypeRequiredDescription
idstring (uuid)YesIdentifier of the inspection.
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.
project_idstring (uuid)YesIdentifier of the project.
inspection_template_idstring (uuid)YesIdentifier of the inspection template.
inspector_person_idstring (uuid) | nullYesIdentifier of the inspector, from the session.
signed_off_bystring (uuid) | nullYesIdentifier of the person who signed off.
signed_off_atstring (date-time) | nullYesWhen it was signed off.
record_idstring (uuid) | nullYesIdentifier of the Inspection record of the same project.
inspected_atstring (date-time)YesWhen the inspection took place.
uridUrid | nullYes
{
  "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",
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspector_person_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "signed_off_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "signed_off_at": "2026-10-08T14:30:00Z",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspected_at": "2026-10-08T14:30:00Z",
  "urid": "4000.01.01"
}

Code samples

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