Inspection Forms

Retrieve Inspection Form

Returns a single Inspection Form.

get/inspection_forms/{id}

Request

Path parameters

idstring required

The id of the relevant record

Response

OK

idinteger

The ID of the Inspection Form.

titlestring

The title or name of the Inspection Form.

descriptionstring

A brief description or explanation of the Inspection Form's purpose or requirements.

updated_atstring date-time

The date and time when the Inspection Form was last updated. Formatted according to ISO-8601 in UTC.

archived_atstring date-time nullable

The date and time when the Inspection Form was archived, if applicable.

require_live_photoboolean

Indicates whether live photos are required as part of the inspection.

versioninteger nullable

The version number of the Inspection Form.

current_form_version_idinteger nullable

The ID of the current version of the Inspection Form.

workflow_assign_user_to_vehicle_enabledboolean

Indicates whether the workflow allows assigning Users to Vehicles for inspections.

Example response

{
  "id": 20,
  "title": "Driver Vehicle Inspection Report (Full)",
  "description": "As required by the US Dept. of Transportation (DOT) Federal Motor Carrier Safety Regulations in FMCSA 396.11.a.1",
  "updated_at": "2023-09-20T08:46:11Z",
  "version": 8,
  "current_form_version_id": 50,
  "inspection_items": [
    {
      "id": 88,
      "inspection_form_version_id": 50,
      "account_id": 18,
      "label": "Odometer Reading",
      "short_description": "Meter Entry Inspection Item.",
      "instructions": "Complete this Inspection Item by entering the odometer reading.",
      "required": true,
      "position": 1,
      "pass_label": "Pass",
      "fail_label": "Fail",
      "reuse_pass_fail_label": true,
      "require_secondary_meter_if_one_exists": true,
      "created_at": "2023-09-20T11:00:19.952-05:00",
      "updated_at": "2016-07-27T20:38:56.454-05:00",
      "version_key": "6552b703-e366-420d-873a-2a4ca0f73acc",
      "na_label": "N/A",
      "numeric_range_min": 3,
      "numeric_range_max": 5
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.