List Inspection Schedules

GET 
https://secure.fleetio.com/api/inspection_schedules

Returns a list of Inspection Schedules.

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.
vehicle_id object
eqstringrequired
inspection_form_id object
eqstringrequired
active object
eqstringrequired
inspection_schedule_status object
eqstringrequired
Possible values: [ok, overdue, due_soon]
last_inspected_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
last_sent_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
next_due_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object

The fields and direction to sort the results by.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

last_inspected_atSortAscDesc (string)

Possible values: [asc, desc]

last_sent_atSortAscDesc (string)

Possible values: [asc, desc]

next_due_atSortAscDesc (string)

Possible values: [asc, desc]

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, 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
vehicle_id object
eqstringrequired
MOD2
inspection_form_id object
eqstringrequired
MOD3
active object
eqstringrequired
MOD4
inspection_schedule_status object
eqstringrequired
Possible values: [ok, overdue, due_soon]
MOD5
last_inspected_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD6
last_sent_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD7
next_due_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD8
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD9
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
last_inspected_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
last_sent_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
next_due_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD5
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD6
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
activebooleanrequired
Whether this Inspection Schedule is active.
vehicle_idintegerrequired
inspection_form_idintegerrequired
The Id of the InspectionForm associated with this Inspection Schedule.
last_submission_idintegernullable
The Id of the most recent SubmittedInspectionForm for this Inspection Schedule.
updated_atdate-time
created_atdate-time
recurring_rule_descriptionstringrequired
This describes the recurrence behavior of the Inspection Schedule.
recurring_schedule_start_atdate-timenullable
The date and time at which this Inspection Schedule's recurrence behavior began. This attribute will only appear in responses if the Inspection Schedule is recurring.
next_due_atdate-time
The date and time at which this Inspection Schedule is next due. This attribute will only appear in responses if there is a next due date.
last_sent_atdate-timenullable
The date and time at which this Inspection Schedule was last sent.
last_inspected_atdate-timenullable
The date and time of the last SubmittedInspectionForm.
inspection_schedule_statusstringrequired
The status of this Inspection Schedule.
Possible values: [due_soon, overdue, ok]
vehicle object
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": [
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "inspection_form_id": {
        "eq": "string"
      }
    },
    {
      "active": {
        "eq": "string"
      }
    },
    {
      "inspection_schedule_status": {
        "eq": "ok"
      }
    },
    {
      "last_inspected_at": {
        "lt": "string"
      }
    },
    {
      "last_sent_at": {
        "lt": "string"
      }
    },
    {
      "next_due_at": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "last_inspected_at": "asc"
    },
    {
      "last_sent_at": "asc"
    },
    {
      "next_due_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "active": true,
      "vehicle_id": 0,
      "inspection_form_id": 0,
      "last_submission_id": 0,
      "updated_at": "2024-07-29T15:51:28.071Z",
      "created_at": "2024-07-29T15:51:28.071Z",
      "recurring_rule_description": "string",
      "recurring_schedule_start_at": "2024-07-29T15:51:28.071Z",
      "next_due_at": "2024-07-29T15:51:28.071Z",
      "last_sent_at": "2024-07-29T15:51:28.071Z",
      "last_inspected_at": "2024-07-29T15:51:28.071Z",
      "inspection_schedule_status": "due_soon",
      "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"
}

403

Insufficient permission to perform this operation

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/inspection_schedules' \
-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

start_cursor — query

per_page — query

filter — query

vehicle_ideq

inspection_form_ideq

activeeq

inspection_schedule_statuseq

last_inspected_atltltegtgte

last_sent_atltltegtgte

next_due_atltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

last_inspected_at---ascdesc

last_sent_at---ascdesc

next_due_at---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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