Retrieve Issue

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

Retrieve the details of an existing Issue.

Request

Path Parameters

id stringrequired

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

The id of the relevant record

Responses

200

OK

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

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

updated_atdate-time

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

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

numberstringrequired

A unique identifier for the Issue.

namestringrequired

The name of the Issue.

summarystringrequired

A summary of the Issue.

descriptionstringnullablerequired

A longer description of the Issue.

statestringrequired

The Issue's current state.

Possible values: [Open, Closed, Resolved]

reported_atdate-timenullablerequired

The date and time at which the issue was reported.

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

reported_by_idNullableId (integer)nullablerequired

Possible values: >= 1

reported_by_namestringnullablerequired

The name of the Contact associated with the User who reported this Issue.

fault_idNullableId (integer)nullablerequired

Possible values: >= 1

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_meter_valuestringnullablerequired

The 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.

vehicle_idId (integer)required

Possible values: >= 1

vehicle_namestringrequired

The name of the Vehicle associated with this Issue.

is_sampleboolean

Indicates whether this Issue is sample data.

created_by_workflowbooleanrequired

Indicates whether this Issue was created by a workflow.

submitted_inspection_form_idNullableId (integer)nullablerequired

Possible values: >= 1

custom_fieldsobjectnullablerequired

*Full details on working with Custom Fields here.

valid_required_custom_fieldsbooleanrequired

dtc_alert_idNullableId (integer)nullablerequired

Possible values: >= 1

assigned_contacts object[]required

An array of assigned Contacts related to the Issue.

Array [

idinteger

created_atdate-time

updated_atdate-time

emailstringnullable

The Contact's email address.

namestringnullable

The Contact's full name.

first_namestringnullable

The Contact's first name.

middle_namestringnullable

The Contact's middle name.

last_namestringnullable

The Contact's last name.

images_countinteger

The number of images associated with this Contact.

Possible values: >= 0

documents_countinteger

The number of documents associated with this Contact.

Possible values: >= 0

comments_countinteger

The number of comments associated with this Contact.

Possible values: >= 0

group_idintegernullable

If this Contact belongs to a Group, this will be the Fleetio ID of that Group.

group_namestringnullable

If this Contact belongs to a Group, this will be the Group's name.

group_hierarchystringnullable

If this Contact belongs to a Group, this will be a pipe delimited string representing the Group hierarchy. Each Group in the list is the parent of the Groups which follow.

Example: Group 1|Group 2|Group 3

technicianbooleannullable

Whether or not the Contact is a Technician.

vehicle_operatorbooleannullable

Whether or not the Contact is a Vehicle Operator.

employeebooleannullable

Whether or not the Contact is an Employee.

birth_datedatenullable

The Contact's birth date.

Example: 2023-03-14

street_addressstringnullable

The Contact's street address.

Example: 123 Main St

street_address_line_2stringnullable

The Contact's street address line 2.

Example: Apt 1

citystringnullable

The Contact's city.

regionstringnullable

The Contact's region, state, or province.

postal_codestringnullable

The Contact's postal code, zip code, or equivalent.

countrystringnullable

The Contact's country.

employee_numberstringnullable

The Contact's employee number.

job_titlestringnullable

The Contact's job title.

Possible values: <= 255 characters

license_classstringnullable

The Contact's driver's license class.

license_numberstringnullable

The Contact's driver's license number.

license_statestringnullable

The locality which issued the Contact's license.

license_expirationdatenullable

The Contact's driver's license expiration date.

Example: 2023-03-14

home_phone_numberstringnullable

The Contact's home phone number.

mobile_phone_numberstringnullable

The Contact's mobile phone number.

work_phone_numberstringnullable

The Contact's work phone number.

other_phone_numberstringnullable

Any other phone number for this Contact.

start_datedatenullable

When the Contact started working for the company, if applicable.

leave_datedatenullable

When the Contact left or will leave the company, if applicable.

hourly_labor_ratefloatnullable

The Contact's hourly rate.

custom_fieldsobjectnullable

*Full details on working with Custom Fields here.

attachment_permissions objectnullable

read_photosboolean

Indicates whether the user has read permission for photos.

manage_photosboolean

Indicates whether the user has permission to manage (eg. upload, delete) photos.

read_documentsboolean

Indicates whether the user has read permission for documents.

manage_documentsboolean

Indicates whether the user has permission to manage (eg. upload, delete) documents.

default_image_urlstringnullable

The URL of the Contact's default image/profile photo, if any.

userobjectnullable

If the Contact is a Fleetio User, those details will be included here.

account_membership_idNullableId (integer)nullable

Possible values: >= 1

last_api_requestdate-timenullable

The last date and time this Contact's associated User made an API request. Null if Contact is not assocated with a User.

last_web_accessdate-timenullable

The last date and time this Contact's associated User signed into the web application. Null if Contact is not assocated with a User.

last_mobile_app_accessdate-timenullable

The last date and time this Contact's associated User used the mobile app. Null if Contact is not assocated with a User.

]

labels object[]required

Array [

idId (integer)

Possible values: >= 1

namestring

]

attachment_permissions objectnullable

read_photosboolean

Indicates whether the user has read permission for photos.

manage_photosboolean

Indicates whether the user has permission to manage (eg. upload, delete) photos.

read_documentsboolean

Indicates whether the user has read permission for documents.

manage_documentsboolean

Indicates whether the user has permission to manage (eg. upload, delete) documents.

is_watchedbooleanrequired

Indicates whether the Issue is watched.

Default value: false

vehicle_image_urlstringnullablerequired

The URL to the image of the Vehicle associated with the Issue.

vehicle_image_url_mediumstringnullablerequired

The URL to a medium-sized Vehicle image associated with the Issue.

vehicle_image_url_smallstringnullablerequired

The URL to a small-sized Vehicle image associated with the Issue.

vehicle_image_url_largestringnullablerequired

The URL to a large-sized Vehicle image associated with the Issue.

watchers_countinteger

The count of watchers related to the Issue.

linked_work_orders object[]nullablerequired

Summative information of linked Work Orders related to the Issue.

Array [

idId (integer)

Possible values: >= 1

numberinteger

The Work Order number.

issued_atdate-time

The date and time at which the Work Order was issued.

]

source objectrequired

Inspection source information.

inspection_form object

idNullableId (integer)nullable

Possible values: >= 1

colorstringnullable

titlestringnullable

inspection_submissions_countintegernullable

The count of inspection submissions related to the Issue.

last_inspection_submission_atdate-timenullable

The date and time of the last inspection submission related to the Issue.

failed_inspection_item_labelstringnullable

The label associated with a failed inspection item.

comments object[]

A list of the comments made on this record.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

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

updated_atdate-time

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

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

commentable_typeCommentableType (string)required

The type of record that the Comment will be left on. Must be associated with a matching commentable_id.

Possible values: [Contact, FleetcorCard, FuelEntry, InventoryJournalEntry, Issue, Part, PurchaseOrder, ServiceEntry, ServiceReminder, SubmittedInspectionItem, Vehicle, VehicleAssignment, Vendor, WexCard, WorkOrder]

commentable_idId (integer)required

Possible values: >= 1

user_idId (integer)required

Possible values: >= 1

titlestringdeprecated

The title of the Comment.

commentstringrequired

The content of the Comment message body.

user_full_namestringrequired

The full name of the User who created the Comment.

user_image_urlstringnullablerequired

The image url for the User who created the Comment.

rich_contentobjectnullablerequired

html_contentstringnullablerequired

The comment message body rendered as HTML.

with_mentionsbooleanrequired

Indicates if the message body contains @mentions.

]

comments_countinteger

The number of comments made on this record.

Possible values: >= 0

documents object[]

A list of the documents attached to this record.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

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

updated_atdate-time

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

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

namestringrequired

The name of the document.

descriptionstringrequired

The description of the document.

documentable_idId (integer)required

Possible values: >= 1

documentable_typeDocumentableType (string)required

Possible values: [ServiceEntry, FuelEntry, Issue, WorkOrder, ExpenseEntry]

file_namestringrequired

The name of the file.

file_mime_typestringrequired

The MIME type of the file.

file_sizenumberrequired

The size of the file in bytes.

file_urlstringrequired

The URL to access the file.

full_file_urlstringrequired

The full URL to access the file, including any necessary authentication or parameters.

]

documents_countinteger

The number of documents attached to this record.

Possible values: >= 0

images object[]

A list of the images attached to this record.

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

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

updated_atdate-time

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

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

imageable_idId (integer)

Possible values: >= 1

imageable_typeImageableType (string)

Possible values: [ExpenseEntry, WorkOrder, Equipment, IssueResolution, ServiceEntry, Vendor, ServiceProgram, Issue, Contact, Part, Vehicle, FuelEntry, SubmittedInspectionItem]

file_namestring

The name of the image file.

file_mime_typeImage MIME Type (string)

Possible values: [image/jpeg, image/gif, image/jif, image/jfif, image/jfi, image/tiff, image/png, image/jpg, image/jpe, image/pdf, image/webp, image/tif, image/psd, image/raw, image/arw, image/cr2, image/nrw, image/k25, image/bmp, image/dip, image/ai, image/eps, image/heif, image/heic, image/ind, image/indd, image/indt, image/jp2, image/j2k, image/jpf, image/jpx, image/jpm, image/mj2, image/x-png]

file_sizenumber

The size of the image file in bytes.

file_urlstring

The URL to access the image file.

full_urlstring

The full URL to access the image file, including any necessary authentication or parameters.

]

images_countinteger

The number of images attached to this record.

Possible values: >= 0

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "number": "string",
  "name": "string",
  "summary": "string",
  "description": "string",
  "state": "Open",
  "reported_at": "2023-03-14T13:46:27-06:00",
  "reported_by_id": 0,
  "reported_by_name": "string",
  "fault_id": 0,
  "due_date": "2023-03-14",
  "due_meter_value": "string",
  "due_secondary_meter_value": 0,
  "overdue": true,
  "vehicle_id": 0,
  "vehicle_name": "string",
  "is_sample": true,
  "created_by_workflow": true,
  "submitted_inspection_form_id": 0,
  "custom_fields": {},
  "valid_required_custom_fields": true,
  "dtc_alert_id": 0,
  "assigned_contacts": [
    {
      "id": 0,
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "email": "string",
      "name": "string",
      "first_name": "string",
      "middle_name": "string",
      "last_name": "string",
      "images_count": 0,
      "documents_count": 0,
      "comments_count": 0,
      "group_id": 0,
      "group_name": "string",
      "group_hierarchy": "Group 1|Group 2|Group 3",
      "technician": true,
      "vehicle_operator": true,
      "employee": true,
      "birth_date": "2023-03-14",
      "street_address": "123 Main St",
      "street_address_line_2": "Apt 1",
      "city": "string",
      "region": "string",
      "postal_code": "string",
      "country": "string",
      "employee_number": "string",
      "job_title": "string",
      "license_class": "string",
      "license_number": "string",
      "license_state": "string",
      "license_expiration": "2023-03-14",
      "home_phone_number": "string",
      "mobile_phone_number": "string",
      "work_phone_number": "string",
      "other_phone_number": "string",
      "start_date": "2024-07-29",
      "leave_date": "2024-07-29",
      "hourly_labor_rate": 0,
      "custom_fields": {},
      "attachment_permissions": {
        "read_photos": true,
        "manage_photos": true,
        "read_documents": true,
        "manage_documents": true
      },
      "default_image_url": "string",
      "user": {},
      "account_membership_id": 0,
      "last_api_request": "2024-07-29T15:51:28.071Z",
      "last_web_access": "2024-07-29T15:51:28.071Z",
      "last_mobile_app_access": "2024-07-29T15:51:28.071Z"
    }
  ],
  "labels": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "attachment_permissions": {
    "read_photos": true,
    "manage_photos": true,
    "read_documents": true,
    "manage_documents": true
  },
  "is_watched": false,
  "vehicle_image_url": "string",
  "vehicle_image_url_medium": "string",
  "vehicle_image_url_small": "string",
  "vehicle_image_url_large": "string",
  "watchers_count": 0,
  "linked_work_orders": [
    {
      "id": 0,
      "number": 0,
      "issued_at": "2024-07-29T15:51:28.071Z"
    }
  ],
  "source": {
    "inspection_form": {
      "id": 0,
      "color": "string",
      "title": "string"
    },
    "inspection_submissions_count": 0,
    "last_inspection_submission_at": "2024-07-29T15:51:28.071Z",
    "failed_inspection_item_label": "string"
  },
  "comments": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "commentable_type": "Contact",
      "commentable_id": 0,
      "user_id": 0,
      "comment": "string",
      "user_full_name": "string",
      "user_image_url": "string",
      "rich_content": {},
      "html_content": "string",
      "with_mentions": true
    }
  ],
  "comments_count": 0,
  "documents": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "name": "string",
      "description": "string",
      "documentable_id": 0,
      "documentable_type": "ServiceEntry",
      "file_name": "string",
      "file_mime_type": "string",
      "file_size": 0,
      "file_url": "string",
      "full_file_url": "string"
    }
  ],
  "documents_count": 0,
  "images": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "imageable_id": 0,
      "imageable_type": "ExpenseEntry",
      "file_name": "string",
      "file_mime_type": "image/jpeg",
      "file_size": 0,
      "file_url": "string",
      "full_url": "string"
    }
  ],
  "images_count": 0
}

401

Request could not be authenticated

application/json

Schema

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.

Example (auto)

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

403

Insufficient permission to perform this operation

application/json

Schema

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.

Example (auto)

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

404

The requested resource could not be located

application/json

Schema

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.

Example (auto)

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

500

Something unexpected happened

application/json

Schema

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.

Example (auto)

{
  "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
• ruby
• python
• csharp
• go
• java
• nodejs
• php

• CURL

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

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

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