List Inspection Schedules

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

Returns a list of Inspection Schedules.

Request

Query Parameters

include_occurrences integer

Includes upcoming_occurrences for each schedule, if any.

Responses

200

OK

Response Headers

X-PaginationLimit

The per page limit. Currently set to 100 but subject to change at any time.

X-Pagination-Current-Page

The current page. Defaults to 1.

X-Pagination-Total-Pages

The total number of pages in the result set. Use this along with Pagination-Current-Page to determine if there are any remaining pages/records to be retrieved.

X-Pagination-Total-Count

The total number of records in the result set (across all pages).

application/json

Schema

Schema

Array [
idId (integer)
Possible values: >= 1
activebooleanrequired
Whether this Inspection Schedule is active.
vehicle_idId (integer)required
Possible values: >= 1
inspection_form_idId (integer)required
Possible values: >= 1
updated_atdate-time
The date and time at which this record was most recently updated.
Example: 2023-03-14T13:46:27-06:00
recurring_rule_descriptionstringrequired
This describes the recurrence behavior of the Inspection Schedule.
overduebooleanrequired
Whether this Inspection Schedule is overdue.
due_soonbooleanrequired
Whether this Inspection Schedule is due soon.
next_duestring
The date on which this Inspection Schedule is next due. This attribute will only appear in responses if there is a next due date.
Example: October 18, 2023
next_due_relative_timestring
The relative time until this Inspection Schedule is next due. If the Inspection Schedule is overdue, it will describe how long ago it was due. This attribute will only appear in responses if there is a next due date, or overdue.
recurring_schedule_start_atstring
The date on which this Inspection Schedule's recurrence behavior began. This attribute will only appear in responses if the Inspection Schedule is recurring.
Example: October 18, 2023
upcoming_occurrencesstring[]
]

Example (auto)

[
  {
    "id": 0,
    "active": true,
    "vehicle_id": 0,
    "inspection_form_id": 0,
    "updated_at": "2023-03-14T13:46:27-06:00",
    "recurring_rule_description": "string",
    "overdue": true,
    "due_soon": true,
    "next_due": "October 18, 2023",
    "next_due_relative_time": "string",
    "recurring_schedule_start_at": "October 18, 2023",
    "upcoming_occurrences": [
      "string"
    ]
  }
]

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/v1/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

include_occurrences — query

ResponseClear

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