List Submitted Inspection Forms
Returns a list of submitted inspection forms.
Submitting inspection forms through the API is not currently supported.
Query Parameters
- start_cursor string
The start cursor for Keyset pagination.
- per_page integer
Possible values:
>= 2
and<= 100
Default value:
50
The number of records per page to return
- filter object
The fields, operations, and values to filter the records by.
inspection_form_id object
eq string requiredinspection_form_version_id object
eq string requiredinspection_form_title object
like string requiredvehicle_id object
eq string requireduser_id object
eq string required
- sort object
The fields and direction to sort the results by.
- failed_items string
Possible values: [
asc
,desc
] - submitted_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
] - id string
Possible values: [
asc
,desc
]Default value:
desc
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
- start_cursor string
The current start cursor of the records returned.
- next_cursor string
The next cursor to retrieve the next page of records.
- per_page integer
The maxumum number of records returned.
- estimated_remaining_count integer
The number of remaining records including the returned records, up to a maximum of 500.
filtered_by object[]
The filters applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
inspection_form_id object
eq stringinspection_form_version_id object
eq stringinspection_form_title object
like stringvehicle_id object
eq stringuser_id object
eq stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
- MOD4
failed_items stringPossible values: [
asc
,desc
]submitted_at stringPossible values: [
asc
,desc
]updated_at stringPossible values: [
asc
,desc
]id stringPossible values: [
asc
,desc
]records object[]
id integerstarted_at date-timeThe date and time at which this Inspection Form was started.
submitted_at date-timeThe date and time at which this Inspection Form was submitted.
date dateThe date on which this Inspection Form was submitted
failed_items integerThe number of failed items on this Inspection Form.
starting_latitude numberThe latitude at which this Inspection Form was started.
starting_longitude numberThe longitude at which this Inspection Form was started.
submitted_latitude numberThe latitude at which this Inspection Form was submitted.
submitted_longitude numberThe longitude at which this Inspection Form was submitted.
inspection_form object
id integertitle stringThe title of the Inspection Form.
description stringThe description of the Inspection Form.
user object
A Contact
id integeremail stringThe Contact's email address.
name stringThe Contact's full name.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.default_image_url stringThe URL of the Contact's default image/profile photo, if any.
vehicle object
A Vehicle
id integername stringThis vehicle's name.
color stringThe color of this Vehicle.
license_plate stringThe license plate number of this Vehicle.
vin stringThe Vehicle Identification Number of this Vehicle.
year stringThis Vehicle's model year.
make stringThe name of this Vehicle's manufacturer.
model stringThe name of the model of this Vehicle.
trim stringThe trim level of this Vehicle.
registration_expiration_month integerPossible values:
<= 12
The month in which this Vehicle's registration expires.
registration_state stringThe state, province, or territory in which this Vehicle is registered.
default_image_url_small stringThe URL of a small-sized version of the default image for this Vehicle.
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"inspection_form_id": {
"eq": "string"
}
},
{
"inspection_form_version_id": {
"eq": "string"
}
},
{
"inspection_form_title": {
"like": "string"
}
},
{
"vehicle_id": {
"eq": "string"
}
},
{
"user_id": {
"eq": "string"
}
}
],
"sorted_by": [
{
"failed_items": "asc"
},
{
"submitted_at": "asc"
},
{
"updated_at": "asc"
},
{
"id": "asc"
}
],
"records": [
{
"id": 0,
"started_at": "2023-03-14T11:02:38-05:00",
"submitted_at": "2023-03-14T11:02:39-05:00",
"date": "2023-03-14",
"failed_items": 0,
"starting_latitude": 0,
"starting_longitude": 0,
"submitted_latitude": 0,
"submitted_longitude": 0,
"inspection_form": {
"id": 0,
"title": "string",
"description": "string"
},
"user": {
"id": 0,
"email": "string",
"name": "string",
"group_id": 0,
"default_image_url": "string"
},
"vehicle": {
"id": 0,
"name": "string",
"color": "string",
"license_plate": "string",
"vin": "string",
"year": "string",
"make": "string",
"model": "string",
"trim": "string",
"registration_expiration_month": 0,
"registration_state": "string",
"default_image_url_small": "string"
}
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}