Skip to main content

List Faults

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

Responses

OK

Response Headers

  • X-PaginationLimit string

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

  • X-Pagination-Current-Page string

    The current page. Defaults to 1.

  • X-Pagination-Total-Pages string

    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 string

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

Schema

array
  • id integer

    Possible values: >= 1

  • created_at date-time

    The date and time at which this record was created.

  • updated_at date-time

    The date and time at which this record was most recently updated.

  • account_id integer

    Possible values: >= 1

  • vehicle_id NullableId

    Possible values: >= 1

  • 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 NullableId

    Possible values: >= 1

  • is_sample boolean

    Indicates if the Fault is sample data.

  • idempotency_key string

    An optional key for idempotent operations.

Loading...