Skip to main content

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.

    • number object
    • eq string required
    • reported_by_id object
    • eq string required
    • assigned_contact_ids object
    • include string required
    • vehicle_id object
    • eq string required
    • equipment_id object
    • eq string required
    • labels object
    • include string required
    • state object
    • eq string required
    • due_date object
      oneOf
    • eq string required
    • resolved_at object
      oneOf
    • lt string required
    • reported_at object
      oneOf
    • lt string required
    • closed_at object
      oneOf
    • lt string required
    • reopened_at object
      oneOf
    • lt string required
    • created_at object
      oneOf
    • lt string required
    • updated_at object
      oneOf
    • lt 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

Responses

OK

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
  • reported_by_id object
  • eq string
  • sorted_by object[]
    anyOf
  • id string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • number string

    A unique identifier for the Issue.

  • state string

    Possible values: [Open, Closed, Resolved]

    The Issue's current state.

  • created_at date-time
  • updated_at date-time
  • name string

    The name of the Issue.

  • description string

    A longer description of the Issue.

  • reported_at date-time

    The date and time at which the issue was reported.

  • resolved_at date-time

    The date and time at which the issue was resolved.

  • resolved_by_id integer

    The id of the User who resolved the Issue.

  • closed_at date-time

    The date and time at which the issue was closed.

  • closed_by_id integer

    The id of the User who closed the Issue.

  • reopened_at date-time

    The date and time at which the issue was reopened.

  • reopened_by_id integer

    The id of the User who reopened the Issue.

  • resolvable_id integer

    The id of the resolvable_type which can resolve this Issue.

  • resolvable_type string

    Possible values: [ServiceEntry, WorkOrder]

    The type of the object which can resolve 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_primary_meter_value string

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

  • overdue boolean

    Indicates whether the Issue is overdue.

  • asset_type string

    Possible values: [Vehicle, Equipment]

    The type of asset this Issue applies to.

  • submitted_inspection_form_id integer

    The id of the associated SubmittedInspectionForm, if any.

  • fault_id integer

    The id of the associated Fault if any.

  • external_id string

    The external ID for this Issue.

  • watchers_count integer

    The count of watchers for this Issue.

  • comments_count integer

    The count of comments for this Issue.

  • documents_count integer

    The count of documents for this Issue.

  • images_count integer

    The count of images for this Issue.

  • custom_fields object

    *Full details on working with Custom Fields here.

  • vehicle object

    A Vehicle

  • id integer
  • name string

    This vehicle's name.

  • color string

    The color of this Vehicle.

  • license_plate string

    The license plate number of this Vehicle.

  • vin string

    The Vehicle Identification Number of this Vehicle.

  • year string

    This Vehicle's model year.

  • make string

    The name of this Vehicle's manufacturer.

  • model string

    The name of the model of this Vehicle.

  • trim string

    The trim level of this Vehicle.

  • registration_expiration_month integer

    Possible values: <= 12

    The month in which this Vehicle's registration expires.

  • registration_state string

    The state, province, or territory in which this Vehicle is registered.

  • default_image_url_small string

    The URL of a small-sized version of the default image for this Vehicle.

  • equipment object
  • id integer
  • name string

    The name for this Equipment.

  • brand string

    The name of the brand which makes this Equipment.

  • model string

    The model name of this Equipment.

  • serial_number string

    The serial number of this Equipment.

  • reported_by object

    A Contact

  • id integer
  • email string

    The Contact's email address.

  • name string

    The Contact's full name.

  • group_id integer

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

  • default_image_url string

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

  • fault_rule object

    A Fault Rule

  • 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

  • code string

    The diagnostic trouble code.

  • description string

    A short description about the problem.

  • priority_handling string

    Possible values: [off, ignore, critical]

    The priority handling for the alert. This is configurable through the Fleetio dashboard under Fault Rules.

  • name string

    A short name for the alert.

  • labels object[]
  • id integer

    Possible values: >= 1

  • name string
  • assigned_contacts object[]
  • id integer
  • email string

    The Contact's email address.

  • name string

    The Contact's full name.

  • group_id integer

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

  • default_image_url string

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

Loading...