List Faults

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

Returns a list of the Faults recorded for all vehicles in your account.

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.
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
external_id object
eqstringrequired
fault_rule_id object
eqstringrequired
vehicle_id object
eqstringrequired
status_id object
includestringrequired
code object
eqstringrequired
last_occurred_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_occurred_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
name object
oneOf
LikeFilter
likestringrequired
EqFilter
eqstringrequired
MOD2
external_id object
eqstringrequired
MOD3
fault_rule_id object
eqstringrequired
MOD4
vehicle_id object
eqstringrequired
MOD5
status object
includestringrequired
MOD6
code object
eqstringrequired
MOD7
last_occurred_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
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
last_occurred_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
account_idintegerrequired
vehicle_idintegernullablerequired
codestringrequired
The diagnostic trouble code.
countintegernullablerequired
The number of times this Fault has occurred.
descriptionstringnullablerequired
A short description about the problem.
external_idstringnullable
An external identifier for the Fault, if applicable.
last_occurred_atdate-timenullablerequired
The date and time when the Fault last occurred.
Example: 2023-03-14T13:46:27-06:00
namestringnullablerequired
The name or label for the Fault.
statusstringrequired
The status of the Fault.
Possible values: [open, resolved, ignored]
Default value: open
sourcestringnullable
The source or origin of the Fault.
vehicle_archived_atdate-timenullablerequired
The date and time when the associated Vehicle was archived, if applicable.
Example: 2023-03-14T13:46:27-06:00
fault_rule_idintegernullable
is_sampleboolean
Indicates if the Fault is sample data.
idempotency_keystringnullable
An optional key for idempotent operations.
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": [
    {
      "name": {
        "like": "string"
      }
    },
    {
      "external_id": {
        "eq": "string"
      }
    },
    {
      "fault_rule_id": {
        "eq": "string"
      }
    },
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "status": {
        "include": "string"
      }
    },
    {
      "code": {
        "eq": "string"
      }
    },
    {
      "last_occurred_at": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "updated_at": "asc"
    },
    {
      "last_occurred_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "account_id": 0,
      "vehicle_id": 0,
      "code": "string",
      "count": 0,
      "description": "string",
      "external_id": "string",
      "last_occurred_at": "2023-03-14T13:46:27-06:00",
      "name": "string",
      "status": "open",
      "source": "string",
      "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
      "fault_rule_id": 0,
      "is_sample": true,
      "idempotency_key": "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

curl -L 'https://secure.fleetio.com/api/v1/faults' \
-H 'Accept: application/json' \
-H 'Authorization: <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

namelikeeq

external_ideq

fault_rule_ideq

vehicle_ideq

status_idinclude

codeeq

last_occurred_atltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

last_occurred_at---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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