List Submitted Inspection Forms

GET 
https://secure.fleetio.com/api/v1/submitted_inspection_forms

Returns a list of submitted inspection forms.

info

Submitting inspection forms through the API is not currently supported.

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return
Default value: 50
filter object
The fields, operations, and values to filter the records by.
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
submitted_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
inspection_form_id object
eqstringrequired
inspection_form_version_id object
eqstringrequired
inspection_form_title object
likestringrequired
vehicle_id object
eqstringrequired
user_id object
eqstringrequired
sort object
The fields and direction to sort the results by.
created_atSortAscDesc (string)
Possible values: [asc, desc]
submitted_atSortAscDesc (string)
Possible values: [asc, desc]
updated_atSortAscDesc (string)
Possible values: [asc, desc]
idSortAscDescDefaultDesc (string)
Possible values: [asc, desc]
Default value: desc

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
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.
Array [
anyOf
MOD1
inspection_form_id object
eqstringrequired
MOD2
inspection_form_version_id object
eqstringrequired
MOD3
inspection_form_title object
likestringrequired
MOD4
vehicle_id object
eqstringrequired
MOD5
user_id object
eqstringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
failed_itemsSortAscDesc (string)
Possible values: [asc, desc]
MOD2
submitted_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idintegerrequired
started_atdate-timerequired
The date and time at which this Inspection Form was started.
Example: 2023-03-14T11:02:38-05:00
submitted_atdate-timerequired
The date and time at which this Inspection Form was submitted.
Example: 2023-03-14T11:02:39-05:00
datedaterequired
The date on which this Inspection Form was submitted
Example: 2023-03-14
failed_itemsintegerrequired
The number of failed items on this Inspection Form.
starting_latitudenumbernullablerequired
The latitude at which this Inspection Form was started.
starting_longitudenumbernullablerequired
The longitude at which this Inspection Form was started.
submitted_latitudenumbernullablerequired
The latitude at which this Inspection Form was submitted.
submitted_longitudenumbernullablerequired
The longitude at which this Inspection Form was submitted.
inspection_form objectrequired
idinteger
titlestring
The title of the Inspection Form.
descriptionstring
The description of the Inspection Form.
user objectnullable
A Contact
idintegerrequired
emailstringnullable
The Contact's email address.
namestringnullablerequired
The Contact's full name.
group_idintegernullable
If this Contact belongs to a Group, this will be the Fleetio ID of that Group.
default_image_urlstringnullablerequired
The URL of the Contact's default image/profile photo, if any.
vehicle objectrequired
A Vehicle
idintegerrequired
namestringrequired
This vehicle's name.
colorstringnullable
The color of this Vehicle.
license_platestringnullable
The license plate number of this Vehicle.
vinstringnullable
The Vehicle Identification Number of this Vehicle.
yearstringnullable
This Vehicle's model year.
makestringnullable
The name of this Vehicle's manufacturer.
modelstringnullable
The name of the model of this Vehicle.
trimstringnullable
The trim level of this Vehicle.
registration_expiration_monthintegernullable
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
registration_statestringnullable
The state, province, or territory in which this Vehicle is registered.
default_image_url_smallstringnullable
The URL of a small-sized version of the default image for this Vehicle.
]

Example (auto)

{
  "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"
      }
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

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"
}

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

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

start_cursor — query

per_page — query

filter — query

created_atltltegtgte

updated_atltltegtgte

submitted_atltltegtgte

inspection_form_ideq

inspection_form_version_ideq

inspection_form_titlelike

vehicle_ideq

user_ideq

sort — query

created_at---ascdesc

submitted_at---ascdesc

updated_at---ascdesc

id---ascdesc

ResponseClear

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