List Service Reminders

GET 
https://secure.fleetio.com/api/v2/service_reminders

Returns a list of Service Reminders belonging to your account.

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
service_task_id object
eqstringrequired
service_reminder_status object
eqstringrequired
Possible values: [ok, overdue, due_soon, snoozed]
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

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
service_task_id object
eqstringrequired
MOD3
service_reminder_status object
eqstringrequired
Possible values: [ok, overdue, due_soon, snoozed]
MOD4
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD5
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
idSortAscDesc (string)
Possible values: [asc, desc]
MOD2
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
updated_atSortAscDesc (string)
Possible values: [asc, desc]
]
records object[]
Array [
idinteger
activeboolean
Indicates whether the Service Reminder is currently active.
vehicle_idinteger
The ID of the Vehicle associated with this Service Reminder.
service_task_idintegernullable
The ID of the ServiceTask associated with this Service Reminder.
comments_countinteger
The count of Comments associated with this Service Reminder.
watchers_countinteger
The count of Users watching this Service Reminder.
starting_intervalbooleannullable
Indicates whether the Service Reminder has a starting interval.
starting_primary_meter_intervalstringnullable
The starting meter interval for the primary meter for this Service Reminder.
starting_secondary_meter_intervalstringnullable
The starting secondary meter interval for this Service Reminder.
primary_meter_intervalstringnullable
The number of primary meter units between each occurance of this Service Reminder.
secondary_meter_intervalstringnullable
The number of secondary meter units between each occurrence of the Service Reminder.
next_due_primary_meter_valuestringnullable
The primary meter value at which the Service Reminder is next due, if applicable.
next_due_secondary_meter_valuestringnullable
The secondary meter value at which the Service Reminder is next due, if applicable.
due_soon_primary_meter_valuestringnullable
The primary meter value at which the Service Reminder is due soon, if applicable.
due_soon_primary_meter_thresholdstringnullable
The primary meter value threshold to which this Service Reminder will be due soon.
Example: 100.5
due_soon_secondary_meter_valuestringnullable
The secondary meter value at which the Service Reminder is due soon, if applicable.
due_soon_secondary_meter_thresholdstringnullable
The secondary meter value threshold to which this Service Reminder will be due soon.
starting_time_intervalintegernullable
The starting time interval according to starting_time_frequency for time-based Service Reminders, if applicable.
starting_time_frequencyFrequency (string)nullable
Possible values: [day, week, month, year, days, weeks, months, years]
time_intervalintegernullable
The number of time units according to time_frequency between each occurrence of the Service Reminder.
time_frequencyFrequency (string)nullable
Possible values: [day, week, month, year, days, weeks, months, years]
snooze_untildate-timenullable
The date and time until which the Service Reminder is snoozed.
Example: 2023-03-14T13:46:27-06:00
next_due_atdate-timenullable
The date and time when the Service Reminder is next due. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
due_soon_atdate-timenullable
The date and time when the Service Reminder will be considered due soon. Formatted according to ISO-8601 in User's local time.
Example: 2023-03-14T13:46:27-06:00
due_soon_time_threshold_intervalintegernullable
The number of time units according to due_soon_time_threshold_frequency between due_soon_at occurrences.
due_soon_time_threshold_frequencyFrequency (string)nullable
Possible values: [day, week, month, year, days, weeks, months, years]
forecasted_primary_due_soon_atdate-timenullable
The forecasted date and time for the primary Service Reminder to be due soon.
Example: 2023-03-14T13:46:27-06:00
forecasted_primary_next_due_atdate-timenullable
The forecasted date and time for the next primary due Service Reminder.
Example: 2023-03-14T13:46:27-06:00
forecasted_secondary_due_soon_atdate-timenullable
The forecasted date and time for the secondary Service Reminder to be due soon.
Example: 2023-03-14T13:46:27-06:00
forecasted_secondary_next_due_atdate-timenullable
The forecasted date and time for the next secondary due Service Reminder.
Example: 2023-03-14T13:46:27-06:00
forecasted_next_due_atdate-timenullable
The forecasted date and time for the next due service.
Example: 2023-03-14T13:46:27-06:00
forecasted_due_soon_atdate-timenullable
The forecasted date and time for the Service Reminder to be due soon.
Example: 2023-03-14T13:46:27-06:00
vehicle_archived_atdate-timenullable
The date and time at which the vehicle associated with the Service Reminder was archived, if applicable.
Example: 2023-03-14T13:46:27-06:00
created_atdate-time
The date and time this Service reminder was created.
updated_atdate-time
The date and time this Service Reminder was last updated.
service_reminder_statusstring
The status of this Service Reminder.
Possible values: [due_soon, overdue, ok, snoozed]
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.
vehicle object
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.
service_task objectnullable
A Service Task
idinteger
namestring
A name for this Service Task.
descriptionstringnullable
A description of this Service Task.
expected_duration_in_secondsintegernullable
The expected duration in seconds this Service Task should take to complete.
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "vehicle_id": {
        "eq": "string"
      }
    },
    {
      "service_task_id": {
        "eq": "string"
      }
    },
    {
      "service_reminder_status": {
        "eq": "ok"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "id": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "active": true,
      "vehicle_id": 0,
      "service_task_id": 0,
      "comments_count": 0,
      "watchers_count": 0,
      "starting_interval": true,
      "starting_primary_meter_interval": "string",
      "starting_secondary_meter_interval": "string",
      "primary_meter_interval": "string",
      "secondary_meter_interval": "string",
      "next_due_primary_meter_value": "string",
      "next_due_secondary_meter_value": "string",
      "due_soon_primary_meter_value": "string",
      "due_soon_primary_meter_threshold": "100.5",
      "due_soon_secondary_meter_value": "string",
      "due_soon_secondary_meter_threshold": "string",
      "starting_time_interval": 0,
      "starting_time_frequency": "day",
      "time_interval": 0,
      "time_frequency": "day",
      "snooze_until": "2023-03-14T13:46:27-06:00",
      "next_due_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",
      "forecasted_primary_due_soon_at": "2023-03-14T13:46:27-06:00",
      "forecasted_primary_next_due_at": "2023-03-14T13:46:27-06:00",
      "forecasted_secondary_due_soon_at": "2023-03-14T13:46:27-06:00",
      "forecasted_secondary_next_due_at": "2023-03-14T13:46:27-06:00",
      "forecasted_next_due_at": "2023-03-14T13:46:27-06:00",
      "forecasted_due_soon_at": "2023-03-14T13:46:27-06:00",
      "vehicle_archived_at": "2023-03-14T13:46:27-06:00",
      "created_at": "2024-07-29T15:51:28.071Z",
      "updated_at": "2024-07-29T15:51:28.071Z",
      "service_reminder_status": "due_soon",
      "attachment_permissions": {
        "read_photos": true,
        "manage_photos": true,
        "read_documents": true,
        "manage_documents": true
      },
      "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"
      },
      "service_task": {
        "id": 0,
        "name": "string",
        "description": "string",
        "expected_duration_in_seconds": 0
      }
    }
  ]
}

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/v2/service_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

service_task_ideq

service_reminder_statuseq

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

next_due_at---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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