List Issues associated with a Vehicle

GET https://secure.fleetio.com/api/vehicles/:id/issues

Returns a list of Issues associated with a Vehicle.

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the Vehicle for the Issues returned.

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

sort object

Responses

application/json

Schema
Example (auto)

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[]

sorted_by object[]

records object[]

Array [

idintegerrequired

numberstringrequired

A unique identifier for the Issue.

statestringrequired

The Issue's current state.

Possible values: [Open, Closed, Resolved]

created_atdate-timerequired

updated_atdate-timerequired

namestringrequired

The name of the Issue.

descriptionstringnullablerequired

A longer description of the Issue.

reported_atdate-timenullablerequired

The date and time at which the issue was reported.

Example: 2023-03-14T13:46:27-06:00

resolved_atdate-timenullablerequired

The date and time at which the issue was resolved.

Example: 2023-03-14T13:46:27-06:00

resolved_by_idintegernullable

The id of the User who resolved the Issue.

closed_atdate-timenullable

The date and time at which the issue was closed.

Example: 2023-03-14T13:46:27-06:00

closed_by_idintegernullable

The id of the User who closed the Issue.

reopened_atdate-timenullable

The date and time at which the issue was reopened.

Example: 2023-03-14T13:46:27-06:00

reopened_by_idintegernullable

The id of the User who reopened the Issue.

resolvable_idintegernullablerequired

The id of the resolvable_type which can resolve this Issue.

resolvable_typestringnullablerequired

The type of the object which can resolve this Issue.

Possible values: [ServiceEntry, WorkOrder]

due_datedatenullablerequired

The date on which this Issue should be resolved by. Formatted according to ISO-8601 in User's local time zone.

Example: 2023-03-14

due_primary_meter_valuestringnullablerequired

The primary meter value at which this Issue should be resolved by.

due_secondary_meter_valuefloatnullablerequired

The secondary meter value at which this Issue should be resolved by.

overduebooleanrequired

Indicates whether the Issue is overdue.

asset_typestringrequired

The type of asset this Issue applies to.

Possible values: [Vehicle, Equipment]

submitted_inspection_form_idintegernullablerequired

The id of the associated SubmittedInspectionForm, if any.

fault_idintegernullablerequired

The id of the associated Fault if any.

external_idstringnullablerequired

The external ID for this Issue.

watchers_countintegerrequired

The count of watchers for this Issue.

comments_countintegerrequired

The count of comments for this Issue.

documents_countintegerrequired

The count of documents for this Issue.

images_countintegerrequired

The count of images for this Issue.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

reported_by objectnullable

fault_rule object

labels object[]

inspection_items object[]

Array [

idinteger

The ID of the Inspection Item.

Example: 88

inspection_form_version_idinteger

The ID of the Inspection Form version to which this item belongs.

Example: 50

account_idinteger

The Fleetio Account ID associated with this Inspection Item.

Example: 18

typestring

The type or category of the Inspection Item.

Possible values: [InspectionDateItem, InspectionDatetimeItem, InspectionDropdownItem, InspectionFreeTextItem, InspectionMeterEntryItem, InspectionNumericItem, InspectionPassFailItem, InspectionPhotoItem, InspectionSectionItem, InspectionSignatureItem, InspectionSingleCheckboxItem]

labelstring

The label or name of the Inspection Item.

Example: Odometer Reading

short_descriptionstringnullable

A brief description of the Inspection Item.

Example: Meter Entry Inspection Item.

instructionsstringnullable

Instructions or guidance for completing the Inspection Item.

Example: Complete this Inspection Item by entering the odometer reading.

requiredboolean

Indicates whether this Inspection Item is required to be completed.

Example: true

positioninteger

The position or order of the Inspection Item within the form.

Example: 1

require_remark_for_failboolean

Indicates whether a remark is required for a "Fail" result.

Example: false

pass_labelstringnullable

The label for a "Pass" result.

Example: Pass

fail_labelstringnullable

The label for a "Fail" result.

Example: Fail

reuse_pass_fail_labelboolean

Indicates whether to reuse pass/fail labels for this item.

Example: true

require_secondary_meter_if_one_existsboolean

Indicates whether a Secondary Meter Entry is required, if a secondary meter is in use.

Example: true

created_atdate-time

The date and time when the Inspection Item was created.

Example: 2023-09-20T11:00:19.952-05:00

updated_atdate-time

The date and time when the Inspection Item was last updated.

Example: 2016-07-27T20:38:56.454-05:00

version_keystringnullable

The version key associated with the Inspection Item.

Example: 6552b703-e366-420d-873a-2a4ca0f73acc

na_labelstringnullable

The label for "Not Applicable" option.

Example: N/A

enable_na_option_for_submissionboolean

Indicates whether the "Not Applicable" option is enabled for submission.

Example: false

require_remark_for_passboolean

Indicates whether a remark is required for a "Pass" result.

Example: false

dropdown_optionsstring[]

An array of options for an InspectionDropdownItem.

numeric_range_minnumbernullable

The minimum value allowed for an InspectionNumericItem.

Example: 3

numeric_range_maxnumbernullable

The maximum value allowed for an InspectionNumericItem.

Example: 5

require_meter_entry_photo_verificationboolean

Indicates whether a photo of the meter is required for verification.

Example: false

]

assigned_contacts object[]

]

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "reported_by_id": {
        "eq": "string"
      }
    },
    {
      "labels": {
        "include": "string"
      }
    },
    {
      "state": {
        "include": "string"
      }
    },
    {
      "due_date": {
        "eq": "string"
      }
    },
    {
      "resolved_at": {
        "lt": "string"
      }
    },
    {
      "reported_at": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    },
    {
      "assigned_contact_ids": {
        "include": "string"
      }
    },
    {
      "closed_at": {
        "lt": "string"
      }
    },
    {
      "reopened_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "id": "asc"
    },
    {
      "due_date": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "resolved_at": "asc"
    },
    {
      "reported_at": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "number": "string",
      "state": "Open",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "name": "string",
      "description": "string",
      "reported_at": "2023-03-14T13:46:27-06:00",
      "resolved_at": "2023-03-14T13:46:27-06:00",
      "resolved_by_id": 0,
      "closed_at": "2023-03-14T13:46:27-06:00",
      "closed_by_id": 0,
      "reopened_at": "2023-03-14T13:46:27-06:00",
      "reopened_by_id": 0,
      "resolvable_id": 0,
      "resolvable_type": "ServiceEntry",
      "due_date": "2023-03-14",
      "due_primary_meter_value": "string",
      "due_secondary_meter_value": 0,
      "overdue": true,
      "asset_type": "Vehicle",
      "submitted_inspection_form_id": 0,
      "fault_id": 0,
      "external_id": "string",
      "watchers_count": 0,
      "comments_count": 0,
      "documents_count": 0,
      "images_count": 0,
      "custom_fields": {},
      "reported_by": {
        "id": 0,
        "email": "string",
        "name": "string",
        "group_id": 0,
        "default_image_url": "string"
      },
      "fault_rule": {
        "id": 0,
        "created_at": "2023-03-14T13:46:27-06:00",
        "updated_at": "2023-03-14T13:46:27-06:00",
        "account_id": 0,
        "code": "string",
        "description": "string",
        "priority_handling": "off",
        "name": "string"
      },
      "labels": [
        {
          "id": 0,
          "name": "string"
        }
      ],
      "inspection_items": [
        {
          "id": 88,
          "inspection_form_version_id": 50,
          "account_id": 18,
          "type": "InspectionDateItem",
          "label": "Odometer Reading",
          "short_description": "Meter Entry Inspection Item.",
          "instructions": "Complete this Inspection Item by entering the odometer reading.",
          "required": true,
          "position": 1,
          "require_remark_for_fail": false,
          "pass_label": "Pass",
          "fail_label": "Fail",
          "reuse_pass_fail_label": true,
          "require_secondary_meter_if_one_exists": true,
          "created_at": "2023-09-20T11:00:19.952-05:00",
          "updated_at": "2016-07-27T20:38:56.454-05:00",
          "version_key": "6552b703-e366-420d-873a-2a4ca0f73acc",
          "na_label": "N/A",
          "enable_na_option_for_submission": false,
          "require_remark_for_pass": false,
          "dropdown_options": [
            "string"
          ],
          "numeric_range_min": 3,
          "numeric_range_max": 5,
          "require_meter_entry_photo_verification": false
        }
      ],
      "assigned_contacts": [
        {
          "id": 0,
          "email": "string",
          "name": "string",
          "group_id": 0,
          "default_image_url": "string"
        }
      ]
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (auto)

Schema

errors object

{
  "errors": {}
}

Request could not be authenticated

application/json

Schema
Example (auto)

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.

{
  "status": 0,
  "title": "string",
  "detail": "string",
  "instance": "string"
}

Something unexpected happened

application/json

Schema
Example (auto)

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.

{
  "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

curl -L 'https://secure.fleetio.com/api/vehicles/:id/issues' \
-H 'Accept: application/json' \
-H 'Authorization: <Authorization>' \
-H 'Account-Token: <Authorization>'

ResponseClear

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

List Issues associated with a Vehicle

https://secure.fleetio.com/api/vehicles/:id/issues

Request​

Path Parameters

Query Parameters

Responses​

Authorization: Authorization

Request

Responses