Skip to main content

List Faults

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

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.

    • name object
      oneOf
    • like string required
    • external_id object
    • eq string required
    • fault_rule_id object
    • eq string required
    • vehicle_id object
    • eq string required
    • status_id object
    • include string required
    • code object
    • eq string required
    • last_occurred_at object
      oneOf
    • lt string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt string required
  • sort object

    The fields and direction to sort the results by.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • last_occurred_at string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, desc]

Responses

OK

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
  • name object
    oneOf
  • like string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • updated_at string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • account_id integer
  • vehicle_id integer
  • code string

    The diagnostic trouble code.

  • count integer

    The number of times this Fault has occurred.

  • description string

    A short description about the problem.

  • external_id string

    An external identifier for the Fault, if applicable.

  • last_occurred_at date-time

    The date and time when the Fault last occurred.

  • name string

    The name or label for the Fault.

  • status string

    Possible values: [open, resolved, ignored]

    Default value: open

    The status of the Fault.

  • source string

    The source or origin of the Fault.

  • vehicle_archived_at date-time

    The date and time when the associated Vehicle was archived, if applicable.

  • fault_rule_id integer
  • is_sample boolean

    Indicates if the Fault is sample data.

  • idempotency_key string

    An optional key for idempotent operations.

  • vehicle object

    A Vehicle

  • id integer
  • name string

    This vehicle's name.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufacturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state, province, or territory in which this Vehicle is registered.

  • default_image_url_small string

    The URL of a small-sized version of the default image for this Vehicle.

Loading...