List Issues
Returns a list of Issues belonging to your account.
Query Parameters
- includes string
Possible values: [
custom_fields
,labels
]A comma-separated list of additional attributes to include in the response.
- 200
- 401
- 500
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).
- application/json
- Schema
- Example (from schema)
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.
- number integer
Possible values:
>= 1
A unique identifier for the Issue.
- summary string
A summary of the Issue.
- description string
A longer description of the Issue.
- state string
Possible values: [
open
,closed
,resolved
]The Issue's current state.
- reported_at date-time
The date and time at which this Issue was reported.
reported_by object
The
Contact
ID of theUser
who reported this Issue.id integerPossible values:
>= 1
- resolvable_type string
Possible values: [
ServiceEntry
,WorkOrder
]The type of the object which can resolve this Issue.
- resolved_at date-time
The date and time at which this Issue was resolved.
resolved_by object
The
Contact
ID of theUser
that resolved this Issue.id integerPossible values:
>= 1
- resolved_note string
Any notes associated with resolving this Issue.
- closed_at date-time
The date and time at which this Issue was closed.
closed_by object
The
Contact
ID of theUser
that closed this Issue.id integerPossible values:
>= 1
- closed_note string
Any notes associated with closing this Issue.
- due_date date
The date on which this Issue should be resolved by. Formatted according to ISO-8601 in
User
's local time zone. - due_meter_value float
The meter value at which this Issue should be resolved by.
- due_secondary_meter_value float
The secondary meter value at which this Issue should be resolved by.
- is_overdue boolean
Indicates whether the Issue is overdue.
issue_priority object
An Issue Priority represents the priority level of an Issue.
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
alias stringCan be used to replace the default priority name provided. Changes how the Issue is displayed throughout Fleetio.
name stringThe name of the Issue Priority.
slug stringIndicates which icon will be shown for the Issue Priority.
description stringA description providing more details about the Issue Priority.
default booleanIndicates whether this Issue Priority will be set as default for new
Issues
.enabled booleanIndicates whether this Issue Priority is currently enabled.
position integerThe position or order of the Issue Priority in a list or hierarchy.
resolvable object
The ID of the object which can resolve this Issue.
id integerPossible values:
>= 1
- creation_type string
Possible values: [
manual
,workflow
]Indicates if this Issue was created manually or by a workflow.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
asset object
id integerPossible values:
>= 1
name stringThe name of the asset associated with the Issue.
image_url_medium stringThe URL to a medium-sized image of the asset associated with the Issue.
- asset_type string
Possible values: [
Vehicle
,Equipment
]The asset type that has the Issue.
submitted_inspection_form object
id integerPossible values:
>= 1
fault object
id integerPossible values:
>= 1
- watchers_count integer
The count of watchers associated with the Issue.
- comments_count integer
The count of
Comments
associated with the Issue. - images_count integer
The count of images associated with the Issue.
- documents_count integer
The count of documents associated with the Issue.
- custom_fields object
*Full details on working with Custom Fields here.
labels object[]
An array of labels associated with the Issue. Can be included in the response by passing
labels
in theincludes
query parameter.id integerPossible values:
>= 1
name stringThe name of the label.
color stringThe color of the label.
[
{
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"number": 0,
"summary": "string",
"description": "string",
"state": "open",
"reported_at": "2023-03-14T13:46:27-06:00",
"reported_by": {
"id": 0
},
"resolvable_type": "ServiceEntry",
"resolved_at": "2023-03-14T13:46:27-06:00",
"resolved_by": {
"id": 0
},
"resolved_note": "string",
"closed_at": "2023-03-14T13:46:27-06:00",
"closed_by": {
"id": 0
},
"closed_note": "string",
"due_date": "2023-03-14",
"due_meter_value": 0,
"due_secondary_meter_value": 0,
"is_overdue": true,
"issue_priority": {
"id": 0,
"created_at": "2023-03-14T13:46:27-06:00",
"updated_at": "2023-03-14T13:46:27-06:00",
"account_id": 0,
"alias": "string",
"name": "string",
"slug": "string",
"description": "string",
"default": true,
"enabled": true,
"position": 0
},
"resolvable": {
"id": 0
},
"creation_type": "manual",
"attachment_permissions": {
"read_photos": true,
"manage_photos": true,
"read_documents": true,
"manage_documents": true
},
"asset": {
"id": 0,
"name": "string",
"image_url_medium": "string"
},
"asset_type": "Vehicle",
"submitted_inspection_form": {
"id": 0
},
"fault": {
"id": 0
},
"watchers_count": 0,
"comments_count": 0,
"images_count": 0,
"documents_count": 0,
"custom_fields": {},
"labels": [
{
"id": 0,
"name": "string",
"color": "string"
}
]
}
]
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"
}