Retrieve Inspection Form

GET 
https://secure.fleetio.com/api/v3/inspection_forms/:id

Returns a single Inspection Form.

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

Responses

200

OK

application/json

Schema

Schema

idinteger
The ID of the Inspection Form.
Example: 20
titlestring
The title or name of the Inspection Form.
Example: Driver Vehicle Inspection Report (Full)
descriptionstring
A brief description or explanation of the Inspection Form's purpose or requirements.
Example: As required by the US Dept. of Transportation (DOT) Federal Motor Carrier Safety Regulations in FMCSA 396.11.a.1
updated_atdate-time
The date and time when the Inspection Form was last updated. Formatted according to ISO-8601 in UTC.
Example: 2023-09-20T08:46:11Z
archived_atdate-timenullable
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.
Example: false
versionintegernullable
The version number of the Inspection Form.
Example: 8
current_form_version_idintegernullable
The ID of the current version of the Inspection Form.
Example: 50
workflow_assign_user_to_vehicle_enabledboolean
Indicates whether the workflow allows assigning Users to Vehicles for inspections.
Example: false
inspection_items object[]
Array [
idinteger
The ID of the Inspection Item.
Example: 88
inspection_form_version_idinteger
The ID of the Inspection Form version to which this item belongs.
Example: 50
account_idinteger
The Fleetio Account ID associated with this Inspection Item.
Example: 18
typestring
The type or category of the Inspection Item.
Possible values: [InspectionDateItem, InspectionDatetimeItem, InspectionDropdownItem, InspectionFreeTextItem, InspectionMeterEntryItem, InspectionNumericItem, InspectionPassFailItem, InspectionPhotoItem, InspectionSectionItem, InspectionSignatureItem, InspectionSingleCheckboxItem]
labelstring
The label or name of the Inspection Item.
Example: Odometer Reading
short_descriptionstringnullable
A brief description of the Inspection Item.
Example: Meter Entry Inspection Item.
instructionsstringnullable
Instructions or guidance for completing the Inspection Item.
Example: Complete this Inspection Item by entering the odometer reading.
requiredboolean
Indicates whether this Inspection Item is required to be completed.
Example: true
positioninteger
The position or order of the Inspection Item within the form.
Example: 1
require_remark_for_failboolean
Indicates whether a remark is required for a "Fail" result.
Example: false
pass_labelstringnullable
The label for a "Pass" result.
Example: Pass
fail_labelstringnullable
The label for a "Fail" result.
Example: Fail
reuse_pass_fail_labelboolean
Indicates whether to reuse pass/fail labels for this item.
Example: true
require_secondary_meter_if_one_existsboolean
Indicates whether a Secondary Meter Entry is required, if a secondary meter is in use.
Example: true
created_atdate-time
The date and time when the Inspection Item was created.
Example: 2023-09-20T11:00:19.952-05:00
updated_atdate-time
The date and time when the Inspection Item was last updated.
Example: 2016-07-27T20:38:56.454-05:00
version_keystringnullable
The version key associated with the Inspection Item.
Example: 6552b703-e366-420d-873a-2a4ca0f73acc
na_labelstringnullable
The label for "Not Applicable" option.
Example: N/A
enable_na_option_for_submissionboolean
Indicates whether the "Not Applicable" option is enabled for submission.
Example: false
require_remark_for_passboolean
Indicates whether a remark is required for a "Pass" result.
Example: false
dropdown_optionsstring[]
An array of options for an InspectionDropdownItem.
numeric_range_minnumbernullable
The minimum value allowed for an InspectionNumericItem.
Example: 3
numeric_range_maxnumbernullable
The maximum value allowed for an InspectionNumericItem.
Example: 5
require_meter_entry_photo_verificationboolean
Indicates whether a photo of the meter is required for verification.
Example: false
]

Example (auto)

{
  "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",
  "archived_at": "2024-07-29T15:51:28.071Z",
  "require_live_photo": false,
  "version": 8,
  "current_form_version_id": 50,
  "workflow_assign_user_to_vehicle_enabled": false,
  "inspection_items": [
    {
      "id": 88,
      "inspection_form_version_id": 50,
      "account_id": 18,
      "type": "InspectionDateItem",
      "label": "Odometer Reading",
      "short_description": "Meter Entry Inspection Item.",
      "instructions": "Complete this Inspection Item by entering the odometer reading.",
      "required": true,
      "position": 1,
      "require_remark_for_fail": false,
      "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",
      "enable_na_option_for_submission": false,
      "require_remark_for_pass": false,
      "dropdown_options": [
        "string"
      ],
      "numeric_range_min": 3,
      "numeric_range_max": 5,
      "require_meter_entry_photo_verification": false
    }
  ]
}

401

Request could not be authenticated

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

404

The requested resource could not be located

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

500

Something unexpected happened

application/json

Schema

Schema

statusintegerrequired

Possible values: >= 400 and <= 599

titlestringrequired

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization.

detailstring

A human-readable explanation specific to this occurrence of the problem.

instancestring

A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.

Example (auto)

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Prefix the value with "Token", for example: "Token 76cbe06c49a64".
You can generate a new API key [here](https://secure.fleetio.com/api_keys).

name: Account-Tokentype: apiKeyin: headerdescription: You can find your Account-Token [here](https://secure.fleetio.com/api_keys)

• curl
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

curl -L 'https://secure.fleetio.com/api/v3/inspection_forms/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Token <Authorization>' \
-H 'Account-Token: <Authorization>'

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

Click the Send API Request button above and see the response here!