Retrieve Vehicle Renewal Reminder

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

Retrieve the details of a Vehicle Renewal Reminder.

Request

Path Parameters

id stringrequired

Possible values: Value must match regular expression ^[0-9]+$

The id of the relevant record

Responses

200

OK

application/json

Schema

Schema

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

vehicle_idId (integer)required

Possible values: >= 1

vehicle_renewal_type_idId (integer)required

Possible values: >= 1

vehicle_renewal_type_namestringrequired

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

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 object[]

Array [

idId (integer)required

Possible values: >= 1

created_atdate-time

The date and time at which this record was created.

Example: 2023-03-14T13:46:27-06:00

updated_atdate-time

The date and time at which this record was most recently updated.

Example: 2023-03-14T13:46:27-06:00

commentable_typeCommentableType (string)required

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

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

commentable_idId (integer)required

Possible values: >= 1

user_idId (integer)required

Possible values: >= 1

titlestringdeprecated

The title of the Comment.

commentstringrequired

The content of the Comment message body.

user_full_namestringrequired

The full name of the User who created the Comment.

user_image_urlstringnullablerequired

The image url for the User who created the Comment.

rich_contentobjectnullablerequired

html_contentstringnullablerequired

The comment message body rendered as HTML.

with_mentionsbooleanrequired

Indicates if the message body contains @mentions.

]

comments_countintegernullablerequired

The number of Comments on this Renewal Reminder.

Possible values: >= 0

overduebooleanrequired

Indicates whether or not this Renewal Reminder is overdue.

Default value: false

due_soonbooleanrequired

Indicates whether or not this Renewal Reminder is due soon.

Default value: false

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]

custom_fieldsobjectrequired

users object[]required

Array [

idId (integer)

Possible values: >= 1

namestringnullable

]

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.

Example (auto)

{
  "id": 0,
  "created_at": "2023-03-14T13:46:27-06:00",
  "updated_at": "2023-03-14T13:46:27-06:00",
  "vehicle_id": 0,
  "vehicle_renewal_type_id": 0,
  "vehicle_renewal_type_name": "string",
  "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
  "comments": [
    {
      "id": 0,
      "created_at": "2023-03-14T13:46:27-06:00",
      "updated_at": "2023-03-14T13:46:27-06:00",
      "commentable_type": "Contact",
      "commentable_id": 0,
      "user_id": 0,
      "comment": "string",
      "user_full_name": "string",
      "user_image_url": "string",
      "rich_content": {},
      "html_content": "string",
      "with_mentions": true
    }
  ],
  "comments_count": 0,
  "overdue": false,
  "due_soon": false,
  "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",
  "custom_fields": {},
  "users": [
    {
      "id": 0,
      "name": "string"
    }
  ],
  "attachment_permissions": {
    "read_photos": true,
    "manage_photos": true,
    "read_documents": true,
    "manage_documents": true
  }
}

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

403

Insufficient permission to perform this operation

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

404

The requested resource could not be located

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

Request Collapse all

Base URL

https://secure.fleetio.com/api

Auth

apiKey

accountToken

Parameters

id — pathrequired

ResponseClear

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