---
title: "List Service Reminders"
method: GET
path: "/service_reminders"
tags: ["Service Reminders"]
---

# List Service Reminders

`GET /service_reminders`

## Request

- Base URL: `https://secure.fleetio.com/api`
- URL: `https://secure.fleetio.com/api/service_reminders`
- Auth: API key in header `Authorization` and API key in header `Account-Token`
- TypeScript: <https://skmtc.dev/fleetio/apis/fleetio-developer-api/docs/service_reminders/get.ts> (a function with typed inputs; its response is checked against the schema)

Returns a list of Service Reminders belonging to your account.

## Query parameters

- `start_cursor` string
- `per_page` integer
- `filter` object
  - `vehicle_id` EqFilter
    - `eq` string, required
  - `service_task_id` EqFilter
    - `eq` string, required
  - `service_reminder_status` ServiceReminderStatusFilter
    - `eq` 'ok' | 'overdue' | 'due_soon' | 'snoozed', required
  - `created_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `updated_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
- `sort` object
  - `id` 'asc' | 'desc'
  - `next_due_at` 'asc' | 'desc'
  - `created_at` 'asc' | 'desc'
  - `updated_at` 'asc' | 'desc'

## Response `200`

OK

- object
  - `start_cursor` string, nullable: The current start cursor of the records returned.
  - `next_cursor` string, nullable: The next cursor to retrieve the next page of records.
  - `per_page` integer: The maximum 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` union[]: The filters applied to the returned record set.
    - union
      - object
        - `vehicle_id` EqFilter
          - `eq` string, required
      - object
        - `service_task_id` EqFilter
          - `eq` string, required
      - object
        - `service_reminder_status` ServiceReminderStatusFilter
          - `eq` 'ok' | 'overdue' | 'due_soon' | 'snoozed', required
      - object
        - `created_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `updated_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
  - `sorted_by` union[]: The sorts applied to the returned record set.
    - union
      - object
        - `id` 'asc' | 'desc'
      - object
        - `created_at` 'asc' | 'desc'
      - object
        - `updated_at` 'asc' | 'desc'
  - `records` ServiceReminderSummary[]
    - `id` integer
    - `active` boolean: Indicates whether the Service Reminder is currently active.
    - `vehicle_id` integer: The ID of the `Vehicle` associated with this Service Reminder.
    - `service_task_id` integer, nullable: The ID of the `ServiceTask` associated with this Service Reminder.
    - `comments_count` integer: The count of `Comments` associated with this Service Reminder.
    - `watchers_count` integer: The count of `Users` watching this Service Reminder.
    - `starting_interval` boolean, nullable: Indicates whether the Service Reminder has a starting interval.
    - `starting_primary_meter_interval` string, nullable: The starting meter interval for the primary meter for this Service Reminder.
    - `starting_secondary_meter_interval` string, nullable: The starting secondary meter interval for this Service Reminder.
    - `primary_meter_interval` string, nullable: The number of primary meter units between each occurance of this Service Reminder.
    - `secondary_meter_interval` string, nullable: The number of secondary meter units between each occurrence of the Service Reminder.
    - `next_due_primary_meter_value` string, nullable: The primary meter value at which the Service Reminder is next due, if applicable.
    - `next_due_secondary_meter_value` string, nullable: The secondary meter value at which the Service Reminder is next due, if applicable.
    - `due_soon_primary_meter_value` string, nullable: The primary meter value at which the Service Reminder is due soon, if applicable.
    - `due_soon_primary_meter_threshold` string, nullable: The primary meter value threshold to which this Service Reminder will be due soon.
    - `due_soon_secondary_meter_value` string, nullable: The secondary meter value at which the Service Reminder is due soon, if applicable.
    - `due_soon_secondary_meter_threshold` string, nullable: The secondary meter value threshold to which this Service Reminder will be due soon.
    - `starting_time_interval` integer, nullable: The starting time interval according to `starting_time_frequency` for time-based Service Reminders, if applicable.
    - `starting_time_frequency` 'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years', nullable
    - `time_interval` integer, nullable: The number of time units according to `time_frequency` between each occurrence of the Service Reminder.
    - `time_frequency` 'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years', nullable
    - `snooze_until` string, date-time, nullable: The date and time until which the Service Reminder is snoozed.
    - `next_due_at` string, date-time, nullable: The date and time when the Service Reminder is next due. Formatted according to ISO-8601 in `User`'s local time.
    - `due_soon_at` string, date-time, nullable: The 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` integer, nullable: The number of time units according to `due_soon_time_threshold_frequency` between `due_soon_at` occurrences.
    - `due_soon_time_threshold_frequency` 'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years', nullable
    - `forecasted_primary_due_soon_at` string, date-time, nullable: The forecasted date and time for the primary Service Reminder to be due soon.
    - `forecasted_primary_next_due_at` string, date-time, nullable: The forecasted date and time for the next primary due Service Reminder.
    - `forecasted_secondary_due_soon_at` string, date-time, nullable: The forecasted date and time for the secondary Service Reminder to be due soon.
    - `forecasted_secondary_next_due_at` string, date-time, nullable: The forecasted date and time for the next secondary due Service Reminder.
    - `forecasted_next_due_at` string, date-time, nullable: The forecasted date and time for the next due service.
    - `forecasted_due_soon_at` string, date-time, nullable: The forecasted date and time for the Service Reminder to be due soon.
    - `vehicle_archived_at` string, date-time, nullable: The date and time at which the vehicle associated with the Service Reminder was archived, if applicable.
    - `created_at` string, date-time: The date and time this Service reminder was created.
    - `updated_at` string, date-time: The date and time this Service Reminder was last updated.
    - `service_reminder_status` 'due_soon' | 'overdue' | 'ok' | 'snoozed': The status of this Service Reminder.
    - `attachment_permissions` AttachmentPermissions, nullable
      - `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.
    - `vehicle` VehicleMini: A Vehicle
      - `id` integer, required
      - `name` string, required: This vehicle's name.
      - `color` string, nullable: The color of this Vehicle.
      - `license_plate` string, nullable: The license plate number of this Vehicle.
      - `vin` string, nullable: The Vehicle Identification Number of this Vehicle.
      - `year` string, nullable: This Vehicle's model year.
      - `make` string, nullable: The name of this Vehicle's manufacturer.
      - `model` string, nullable: The name of the model of this Vehicle.
      - `trim` string, nullable: The trim level of this Vehicle.
      - `registration_expiration_month` integer, nullable: The month in which this Vehicle's registration expires.
      - `registration_state` string, nullable: The state, province, or territory in which this Vehicle is registered.
      - `default_image_url_small` string, nullable: The URL of a small-sized version of the default image for this Vehicle.
    - `service_task` ServiceTaskMini, nullable: A Service Task
      - `id` integer
      - `name` string: A name for this Service Task.
      - `description` string, nullable: A description of this Service Task.
      - `expected_duration_in_seconds` integer, nullable: The expected duration in seconds this Service Task should take to complete.

## Other responses

- `400`: The format or parameters of the request was invalid
- `401`: Request could not be authenticated
- `500`: Something unexpected happened

## Changes

- **2026-11-06** `49558d744bd7`: 1 info
  - for the `query` request parameter `per_page`, the min was decreased from `2.00` to `1.00`

[Operation history](https://skmtc.dev/fleetio/apis/fleetio-developer-api/changes/service_reminders/get.md)

---

[API](https://skmtc.dev/fleetio/apis/fleetio-developer-api.md) - [All operations](https://skmtc.dev/fleetio/apis/fleetio-developer-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fleetio/apis/fleetio-developer-api/revisions/49558d744bd7?raw)