List Issues
Returns a list of Issues belonging to 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.
reported_by_id object
eq string requiredvehicle_id object
eq string requiredequipment_id object
eq string requiredlabels object
include string requiredstate object
eq string requireddue_date object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
lt string requiredlte string requiredgt string requiredgte string requiredeq string requiredresolved_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredreported_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string required
- sort object
The fields and direction to sort the results by.
- due_date string
Possible values: [
asc
,desc
] - resolved_at string
Possible values: [
asc
,desc
] - reported_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
] - created_at string
Possible values: [
asc
,desc
] - id string
Possible values: [
asc
,desc
]Default value:
desc
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
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- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
- MOD7
- MOD8
- MOD9
reported_by_id object
eq stringvehicle_id object
eq stringequipment_id object
eq stringlabels object
include stringdue_date object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
lt stringlte stringgt stringgte stringeq stringresolved_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringreported_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringcreated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
anyOf- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
- MOD6
id stringPossible values: [
asc
,desc
]due_date stringPossible values: [
asc
,desc
]updated_at stringPossible values: [
asc
,desc
]created_at stringPossible values: [
asc
,desc
]resolved_at stringPossible values: [
asc
,desc
]reported_at stringPossible values: [
asc
,desc
]records object[]
id integernumber stringA unique identifier for the Issue.
state stringPossible values: [
Open
,Closed
,Resolved
]The Issue's current state.
created_at date-timeupdated_at date-timename stringThe name of the Issue.
description stringA longer description of the Issue.
reported_at date-timeThe date and time at which the issue was reported.
resolved_at date-timeThe date and time at which the issue was resolved.
resolvable_id integerThe id of the resolvable_type which can resolve this Issue.
resolvable_type stringPossible values: [
ServiceEntry
,WorkOrder
]The type of the object which can resolve this Issue.
due_date dateThe date on which this Issue should be resolved by. Formatted according to ISO-8601 in
User
's local time zone.due_primary_meter_value stringThe primary meter value at which this Issue should be resolved by.
due_secondary_meter_value floatThe secondary meter value at which this Issue should be resolved by.
overdue booleanIndicates whether the Issue is overdue.
asset_type stringPossible values: [
Vehicle
,Equipment
]The type of asset this Issue applies to.
submitted_inspection_form_id integerThe id of the associated
SubmittedInspectionForm
, if any.fault_id integerThe id of the associated
Fault
if any.external_id stringThe external ID for this Issue.
watchers_count integerThe count of watchers for this Issue.
comments_count integerThe count of comments for this Issue.
documents_count integerThe count of documents for this Issue.
images_count integerThe count of images for this Issue.
custom_fields object*Full details on working with Custom Fields here.
vehicle object
anyOf- Vehicle
id integername stringThis vehicle's name.
color stringThe color of this Vehicle.
license_plate stringThe license plate number of this Vehicle.
vin stringThe Vehicle Identification Number of this Vehicle.
year stringThis Vehicle's model year.
make stringThe name of this Vehicle's manufacturer.
model stringThe name of the model of this Vehicle.
trim stringThe trim level of this Vehicle.
registration_expiration_month integerPossible values:
<= 12
The month in which this Vehicle's registration expires.
registration_state stringThe state, province, or territory in which this Vehicle is registered.
default_image_url_small stringThe URL of a small-sized version of the default image for this Vehicle.
equipment object
anyOf- Equipment
id integername stringThe name for this Equipment.
brand stringThe name of the brand which makes this Equipment.
model stringThe model name of this Equipment.
serial_number stringThe serial number of this Equipment.
reported_by object
anyOf- Contact
id integeremail stringThe Contact's email address.
name stringThe Contact's full name.
group_id integerIf this Contact belongs to a Group, this will be the Fleetio ID of that
Group
.default_image_url stringThe URL of the Contact's default image/profile photo, if any.
fault_rule object
anyOf- Fault Rule
id integerPossible values:
>= 1
created_at date-timeThe date and time at which this record was created.
updated_at date-timeThe date and time at which this record was most recently updated.
account_id integerPossible values:
>= 1
code stringThe diagnostic trouble code.
description stringA short description about the problem.
priority_handling stringPossible values: [
off
,ignore
,critical
]The priority handling for the alert. This is configurable through the Fleetio dashboard under Fault Rules.
name stringA short name for the alert.
{
"start_cursor": "string",
"next_cursor": "string",
"per_page": 0,
"estimated_remaining_count": 0,
"filtered_by": [
{
"reported_by_id": {
"eq": "string"
}
},
{
"vehicle_id": {
"eq": "string"
}
},
{
"equipment_id": {
"eq": "string"
}
},
{
"labels": {
"include": "string"
}
},
{
"due_date": {
"lt": "string"
}
},
{
"resolved_at": {
"lt": "string"
}
},
{
"reported_at": {
"lt": "string"
}
},
{
"created_at": {
"lt": "string"
}
},
{
"updated_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-05-06",
"updated_at": "2024-05-06",
"name": "string",
"description": "string",
"reported_at": "2023-03-14T13:46:27-06:00",
"resolved_at": "2023-03-14T13:46:27-06:00",
"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": {},
"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"
},
"equipment": {
"id": 0,
"name": "string",
"brand": "string",
"model": "string",
"serial_number": "string"
},
"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"
}
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
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 (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
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"
}