Skip to content

Create an inspection

Safety module

POST/inspectionsinspections.create

An inspection performed from a template, with sign-off. Creates an inspection. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requires the capability safety.inspection.write.
  • OAuth scopes: safety.
  • Send an Idempotency-Key header. A replay with the same key returns the original response.
  • Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: InspectionCreate

inspections.create: InspectionCreate
FieldTypeRequiredDescription
project_idstring (uuid)YesIdentifier of the project.
inspection_template_idstring (uuid)YesIdentifier of the inspection template.
record_idstring (uuid) | nullNoIdentifier of the Inspection record of the same project.
inspected_atstring (date-time)NoWhen the inspection took place.
uridUrid | nullNo
{
  "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "inspected_at": "2026-10-08T14:30:00Z"
}

Response 201: Inspection

inspections.create: 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 POST "$XOS_BASE_URL/inspections" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","inspection_template_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","inspected_at":"2026-10-08T14:30:00Z"}'
const { data } = await xos.inspections.create({
    "project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "inspected_at": "2026-10-08T14:30:00Z"
  });
response = xos.inspections.create({"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "inspection_template_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "record_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "inspected_at": "2026-10-08T14:30:00Z"})
xos inspections create --data '{"project_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","inspection_template_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","record_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","inspected_at":"2026-10-08T14:30:00Z"}'