Skip to main content

List Vehicle Renewal Reminders

Returns a list of your Vehicle Renewal Reminders

Responses

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

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.

  • vehicle_id integer

    Possible values: >= 1

  • vehicle_renewal_type_id integer

    Possible values: >= 1

  • vehicle_renewal_type_name string

    The name of the Vehicle Renewal Type associated with this reminder.

  • vehicle_archived_at date-time

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

  • comments object[]
  • 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.

  • commentable_type CommentableType

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

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

  • commentable_id integer

    Possible values: >= 1

  • user_id integer

    Possible values: >= 1

  • title string deprecated

    The title of the Comment.

  • comment string

    The content of the Comment message body.

  • user_full_name string

    The full name of the User who created the Comment.

  • user_image_url string

    The image url for the User who created the Comment.

  • rich_content object
  • html_content string

    The comment message body rendered as HTML.

  • with_mentions boolean

    Indicates if the message body contains @mentions.

  • comments_count integer

    The number of Comments on this Renewal Reminder.

  • overdue boolean

    Default value: false

    Indicates whether or not this Renewal Reminder is overdue.

  • due_soon boolean

    Default value: false

    Indicates whether or not this Renewal Reminder is due soon.

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

  • custom_fields object
  • users object[]
  • id integer

    Possible values: >= 1

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

Loading...