Skip to main content

List Service Reminders

Returns a list of Service Reminders 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.

    • vehicle_id object
    • eq string required
    • service_task_id object
    • eq string required
    • service_reminder_status object
    • eq string required

      Possible values: [ok, overdue, due_soon, snoozed]

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

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • next_due_at string

      Possible values: [asc, desc]

    • created_at string

      Possible values: [asc, desc]

    • updated_at string

      Possible values: [asc, 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
  • vehicle_id object
  • eq string
  • sorted_by object[]

    The sorts applied to the returned record set.

    anyOf
  • id string

    Possible values: [asc, desc]

  • records object[]
  • id integer
  • active boolean

    Indicates whether the Service Reminder is currently active.

  • vehicle_id integer

    The ID of the Vehicle associated with this Service Reminder.

  • service_task_id integer

    The ID of the ServiceTask associated with this Service Reminder.

  • comments_count integer

    The count of Comments associated with this Service Reminder.

  • watchers_count integer

    The count of Users watching this Service Reminder.

  • starting_interval boolean

    Indicates whether the Service Reminder has a starting interval.

  • starting_primary_meter_interval string

    The starting meter interval for the primary meter for this Service Reminder.

  • starting_secondary_meter_interval string

    The starting secondary meter interval for this Service Reminder.

  • primary_meter_interval string

    The number of primary meter units between each occurance of this Service Reminder.

  • secondary_meter_interval string

    The number of secondary meter units between each occurrence of the Service Reminder.

  • next_due_primary_meter_value string

    The primary meter value at which the Service Reminder is next due, if applicable.

  • next_due_secondary_meter_value string

    The secondary meter value at which the Service Reminder is next due, if applicable.

  • due_soon_primary_meter_value string

    The primary meter value at which the Service Reminder is due soon, if applicable.

  • due_soon_primary_meter_threshold string

    The primary meter value threshold to which this Service Reminder will be due soon.

  • due_soon_secondary_meter_value string

    The secondary meter value at which the Service Reminder is due soon, if applicable.

  • due_soon_secondary_meter_threshold string

    The secondary meter value threshold to which this Service Reminder will be due soon.

  • starting_time_interval integer

    The starting time interval according to starting_time_frequency for time-based Service Reminders, if applicable.

  • starting_time_frequency string

    Possible values: [day, week, month, year, days, weeks, months, years]

  • time_interval integer

    The number of time units according to time_frequency between each occurrence of the Service Reminder.

  • time_frequency string

    Possible values: [day, week, month, year, days, weeks, months, years]

  • snooze_until date-time

    The date and time until which the Service Reminder is snoozed.

  • next_due_at date-time

    The date and time when the Service Reminder is next due. Formatted according to ISO-8601 in User's local time.

  • due_soon_at date-time

    The date and time when the Service Reminder will be considered due soon. Formatted according to ISO-8601 in User's local time.

  • due_soon_time_threshold_interval integer

    The number of time units according to due_soon_time_threshold_frequency between due_soon_at occurrences.

  • due_soon_time_threshold_frequency string

    Possible values: [day, week, month, year, days, weeks, months, years]

  • forecasted_primary_due_soon_at date-time

    The forecasted date and time for the primary Service Reminder to be due soon.

  • forecasted_primary_next_due_at date-time

    The forecasted date and time for the next primary due Service Reminder.

  • forecasted_secondary_due_soon_at date-time

    The forecasted date and time for the secondary Service Reminder to be due soon.

  • forecasted_secondary_next_due_at date-time

    The forecasted date and time for the next secondary due Service Reminder.

  • forecasted_next_due_at date-time

    The forecasted date and time for the next due service.

  • forecasted_due_soon_at date-time

    The forecasted date and time for the Service Reminder to be due soon.

  • vehicle_archived_at date-time

    The date and time at which the vehicle associated with the Service Reminder was archived, if applicable.

  • created_at date-time

    The date and time this Service reminder was created.

  • updated_at date-time

    The date and time this Service Reminder was last updated.

  • service_reminder_status string

    Possible values: [due_soon, overdue, ok, snoozed]

    The status of this Service Reminder.

  • attachment_permissions object
  • read_photos boolean

    Indicates whether the user has read permission for photos.

  • manage_photos boolean

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

  • read_documents boolean

    Indicates whether the user has read permission for documents.

  • manage_documents boolean

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

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

  • service_task object

    A Service Task

  • id integer
  • name string

    A name for this Service Task.

  • description string

    A description of this Service Task.

  • expected_duration_in_seconds integer

    The expected duration in seconds this Service Task should take to complete.

Loading...