Skip to main content

List Vehicle Renewal Reminders

Returns a list of your Vehicle Renewal Reminders

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
    • vehicle_renewal_type_id object
    • eq string required
    • active object
    • eq string required
    • vehicle_renewal_reminder_status object
    • eq string required

      Possible values: [ok, overdue, due_soon]

    • due_soon_at object
      oneOf
    • lt string required
    • last_sent_at object
      oneOf
    • lt string required
    • next_due_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.

    • id string

      Possible values: [asc, desc]

      Default value: desc

    • due_soon_at string

      Possible values: [asc, desc]

    • last_sent_at string

      Possible values: [asc, 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
  • due_soon_at string

    Possible values: [asc, desc]

  • records object[]
  • vehicle_id integer
  • vehicle_renewal_type_id integer
  • vehicle_archived_at date-time

    The date and time at which this Renewal Reminder's Vehicle was archived, if applicable.

  • comments_count integer

    The number of Comments on this Renewal Reminder.

  • active boolean

    Whether or not this Renewal Reminder is active.

  • next_due_at date-time

    The date and time at which this Renewal Reminder is next due.

  • last_sent_at date-time

    The date and time at which this Renewal Reminder was last sent.

  • due_soon_at date-time

    The date and time at which this Renewal Reminder will next be marked as "Due Soon".

  • due_soon_time_threshold_interval integer

    The amount of time before a Renewal is due where it will be marked as as "Due Soon".

  • due_soon_time_threshold_frequency string

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

  • vehicle_renewal_reminder_status string

    Possible values: [ok, overdue, due_soon]

    The current status of this Vehicle Renewal 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.

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

Loading...