List Service Reminders
Returns a list of Service Reminders belonging to your account.
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 requiredservice_task_id object
eq string requiredservice_reminder_status object
eq string requiredPossible values: [
ok
,overdue
,due_soon
,snoozed
]created_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string requiredupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt string requiredlte string requiredgt string requiredgte string required
- sort object
The fields and direction to sort the results by.
- id string
Possible values: [
asc
,desc
]Default value:
desc
- next_due_at string
Possible values: [
asc
,desc
] - created_at string
Possible values: [
asc
,desc
] - updated_at string
Possible values: [
asc
,desc
]
- 200
- 400
- 401
- 500
OK
- application/json
- Schema
- Example (from schema)
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- MOD1
- MOD2
- MOD3
- MOD4
- MOD5
vehicle_id object
eq stringservice_task_id object
eq stringservice_reminder_status object
eq stringPossible values: [
ok
,overdue
,due_soon
,snoozed
]created_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringupdated_at object
oneOf- MOD1
- MOD2
- MOD3
- MOD4
lt stringlte stringgt stringgte stringsorted_by object[]
The sorts applied to the returned record set.
anyOf- MOD1
- MOD2
- MOD3
id stringPossible values: [
asc
,desc
]created_at stringPossible values: [
asc
,desc
]updated_at stringPossible values: [
asc
,desc
]records object[]
id integeractive booleanIndicates whether the Service Reminder is currently active.
vehicle_id integerThe ID of the
Vehicle
associated with this Service Reminder.service_task_id integerThe ID of the
ServiceTask
associated with this Service Reminder.comments_count integerThe count of
Comments
associated with this Service Reminder.watchers_count integerThe count of
Users
watching this Service Reminder.starting_interval booleanIndicates whether the Service Reminder has a starting interval.
starting_primary_meter_interval stringThe starting meter interval for the primary meter for this Service Reminder.
starting_secondary_meter_interval stringThe starting secondary meter interval for this Service Reminder.
primary_meter_interval stringThe number of primary meter units between each occurance of this Service Reminder.
secondary_meter_interval stringThe number of secondary meter units between each occurrence of the Service Reminder.
next_due_primary_meter_value stringThe primary meter value at which the Service Reminder is next due, if applicable.
next_due_secondary_meter_value stringThe secondary meter value at which the Service Reminder is next due, if applicable.
due_soon_primary_meter_value stringThe primary meter value at which the Service Reminder is due soon, if applicable.
due_soon_primary_meter_threshold stringThe primary meter value threshold to which this Service Reminder will be due soon.
due_soon_secondary_meter_value stringThe secondary meter value at which the Service Reminder is due soon, if applicable.
due_soon_secondary_meter_threshold stringThe secondary meter value threshold to which this Service Reminder will be due soon.
starting_time_interval integerThe starting time interval according to
starting_time_frequency
for time-based Service Reminders, if applicable.starting_time_frequency stringPossible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
]time_interval integerThe number of time units according to
time_frequency
between each occurrence of the Service Reminder.time_frequency stringPossible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
]snooze_until date-timeThe date and time until which the Service Reminder is snoozed.
next_due_at date-timeThe date and time when the Service Reminder is next due. Formatted according to ISO-8601 in
User
's local time.due_soon_at date-timeThe date and time when the Service Reminder will be considered due soon. Formatted according to ISO-8601 in
User
's local time.due_soon_time_threshold_interval integerThe number of time units according to
due_soon_time_threshold_frequency
betweendue_soon_at
occurrences.due_soon_time_threshold_frequency stringPossible values: [
day
,week
,month
,year
,days
,weeks
,months
,years
]forecasted_primary_due_soon_at date-timeThe forecasted date and time for the primary Service Reminder to be due soon.
forecasted_primary_next_due_at date-timeThe forecasted date and time for the next primary due Service Reminder.
forecasted_secondary_due_soon_at date-timeThe forecasted date and time for the secondary Service Reminder to be due soon.
forecasted_secondary_next_due_at date-timeThe forecasted date and time for the next secondary due Service Reminder.
forecasted_next_due_at date-timeThe forecasted date and time for the next due service.
forecasted_due_soon_at date-timeThe forecasted date and time for the Service Reminder to be due soon.
vehicle_archived_at date-timeThe date and time at which the vehicle associated with the Service Reminder was archived, if applicable.
created_at date-timeThe date and time this Service reminder was created.
updated_at date-timeThe date and time this Service Reminder was last updated.
service_reminder_status stringPossible values: [
due_soon
,overdue
,ok
,snoozed
]The status of this Service Reminder.
attachment_permissions object
read_photos booleanIndicates whether the user has read permission for photos.
manage_photos booleanIndicates whether the user has permission to manage (eg. upload, delete) photos.
read_documents booleanIndicates whether the user has read permission for documents.
manage_documents booleanIndicates whether the user has permission to manage (eg. upload, delete) documents.
vehicle object
A Vehicle
id integername stringThis vehicle's name.
color stringThe color of this Vehicle.
license_plate stringThe license plate number of this Vehicle.
vin stringThe Vehicle Identification Number of this Vehicle.
year stringThis Vehicle's model year.
make stringThe name of this Vehicle's manufacturer.
model stringThe name of the model of this Vehicle.
trim stringThe trim level of this Vehicle.
registration_expiration_month integerPossible values:
<= 12
The month in which this Vehicle's registration expires.
registration_state stringThe state, province, or territory in which this Vehicle is registered.
default_image_url_small stringThe URL of a small-sized version of the default image for this Vehicle.
service_task object
A Service Task
id integername stringA name for this Service Task.
description stringA description of this Service Task.
expected_duration_in_seconds integerThe expected duration in seconds this Service Task should take to complete.
{
"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-10-07",
"updated_at": "2024-10-07",
"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
}
}
]
}
The format or parameters of the request was invalid
- application/json
- Schema
- Example (from schema)
Schema
errors object
typeitems string
{
"errors": {}
}
Request could not be authenticated
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}
Something unexpected happened
- application/json
- Schema
- Example (from schema)
Schema
- status integer
Possible values:
>= 400
and<= 599
- title string
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.
- detail string
A human-readable explanation specific to this occurrence of the problem.
- instance string
A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
{
"status": 0,
"title": "string",
"detail": "string",
"instance": "string"
}