List Vehicle Renewal Reminders

GET 
https://secure.fleetio.com/api/vehicle_renewal_reminders

Returns a list of your Vehicle Renewal Reminders

Request

Query Parameters

start_cursor string

The start cursor for Keyset pagination.

per_page integer
Possible values: >= 2 and <= 100
The number of records per page to return.
Default value: 50
filter object
The fields, operations, and values to filter the records by.
vehicle_id object
eqstringrequired
vehicle_renewal_type_id object
eqstringrequired
active object
eqstringrequired
vehicle_renewal_reminder_status object
eqstringrequired
Possible values: [ok, overdue, due_soon]
due_soon_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
last_sent_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
next_due_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
sort object

The fields and direction to sort the results by.

idSortAscDescDefaultDesc (string)

Possible values: [asc, desc]

Default value: desc

due_soon_atSortAscDesc (string)

Possible values: [asc, desc]

last_sent_atSortAscDesc (string)

Possible values: [asc, desc]

next_due_atSortAscDesc (string)

Possible values: [asc, desc]

created_atSortAscDesc (string)

Possible values: [asc, desc]

updated_atSortAscDesc (string)

Possible values: [asc, desc]

Responses

200

OK

application/json

Schema

Schema

start_cursorstringnullable
The current start cursor of the records returned.
next_cursorstringnullable
The next cursor to retrieve the next page of records.
per_pageinteger
The maxumum number of records returned.
estimated_remaining_countinteger
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.
Array [
anyOf
MOD1
vehicle_id object
eqstringrequired
MOD2
vehicle_renewal_type_id object
eqstringrequired
MOD3
active object
eqstringrequired
MOD4
vehicle_renewal_reminder_status object
eqstringrequired
Possible values: [ok, overdue, due_soon]
MOD5
due_soon_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD6
last_sent_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD7
next_due_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD8
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD9
updated_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
]
sorted_by object[]
The sorts applied to the returned record set.
Array [
anyOf
MOD1
due_soon_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
last_sent_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
next_due_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD5
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD6
idSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
vehicle_idintegerrequired
vehicle_renewal_type_idintegerrequired
vehicle_archived_atdate-timenullablerequired
The date and time at which this Renewal Reminder's Vehicle was archived, if applicable.
Example: 2023-03-14T13:46:27-06:00
comments_countintegernullablerequired
The number of Comments on this Renewal Reminder.
Possible values: >= 0
activebooleannullablerequired
Whether or not this Renewal Reminder is active.
next_due_atdate-timerequired
The date and time at which this Renewal Reminder is next due.
Example: 2023-03-14T13:46:27-06:00
last_sent_atdate-timenullablerequired
The date and time at which this Renewal Reminder was last sent.
Example: 2023-03-14T13:46:27-06:00
due_soon_atdate-timenullablerequired
The date and time at which this Renewal Reminder will next be marked as "Due Soon".
Example: 2023-03-14T13:46:27-06:00
due_soon_time_threshold_intervalintegernullablerequired
The amount of time before a Renewal is due where it will be marked as as "Due Soon".
due_soon_time_threshold_frequencyFrequency (string)nullablerequired
Possible values: [day, week, month, year, days, weeks, months, years]
vehicle_renewal_reminder_statusstringrequired
The current status of this Vehicle Renewal Reminder.
Possible values: [ok, overdue, due_soon]
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.
custom_fieldsobjectnullable
*Full details on working with Custom Fields here.
vehicle objectrequired
A Vehicle
idintegerrequired
namestringrequired
This vehicle's name.
colorstringnullable
The color of this Vehicle.
license_platestringnullable
The license plate number of this Vehicle.
vinstringnullable
The Vehicle Identification Number of this Vehicle.
yearstringnullable
This Vehicle's model year.
makestringnullable
The name of this Vehicle's manufacturer.
modelstringnullable
The name of the model of this Vehicle.
trimstringnullable
The trim level of this Vehicle.
registration_expiration_monthintegernullable
The month in which this Vehicle's registration expires.
Possible values: >= 0 and <= 12
registration_statestringnullable
The state, province, or territory in which this Vehicle is registered.
default_image_url_smallstringnullable
The URL of a small-sized version of the default image for this Vehicle.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "vehicle_renewal_type_id": {
        "eq": "string"
      }
    },
    {
      "active": {
        "eq": "string"
      }
    },
    {
      "vehicle_renewal_reminder_status": {
        "eq": "ok"
      }
    },
    {
      "due_soon_at": {
        "lt": "string"
      }
    },
    {
      "last_sent_at": {
        "lt": "string"
      }
    },
    {
      "next_due_at": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "due_soon_at": "asc"
    },
    {
      "last_sent_at": "asc"
    },
    {
      "next_due_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "vehicle_id": 0,
      "vehicle_renewal_type_id": 0,
      "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
      "comments_count": 0,
      "active": true,
      "next_due_at": "2023-03-14T13:46:27-06:00",
      "last_sent_at": "2023-03-14T13:46:27-06:00",
      "due_soon_at": "2023-03-14T13:46:27-06:00",
      "due_soon_time_threshold_interval": 0,
      "due_soon_time_threshold_frequency": "day",
      "vehicle_renewal_reminder_status": "ok",
      "attachment_permissions": {
        "read_photos": true,
        "manage_photos": true,
        "read_documents": true,
        "manage_documents": true
      },
      "custom_fields": {},
      "vehicle": {
        "id": 0,
        "name": "string",
        "color": "string",
        "license_plate": "string",
        "vin": "string",
        "year": "string",
        "make": "string",
        "model": "string",
        "trim": "string",
        "registration_expiration_month": 0,
        "registration_state": "string",
        "default_image_url_small": "string"
      }
    }
  ]
}

400

The format or parameters of the request was invalid

application/json

Schema

Schema

errors object
property name* string[]
Array [
string
]

Example (auto)

{
  "errors": {}
}

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"
}

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/vehicle_renewal_reminders' \
-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

start_cursor — query

per_page — query

filter — query

vehicle_ideq

vehicle_renewal_type_ideq

activeeq

vehicle_renewal_reminder_statuseq

due_soon_atltltegtgte

last_sent_atltltegtgte

next_due_atltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

due_soon_at---ascdesc

last_sent_at---ascdesc

next_due_at---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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