---
title: "List Contact Renewal Reminders"
method: GET
path: "/contact_renewal_reminders"
tags: ["Contact Renewal Reminders"]
---

# List Contact Renewal Reminders

`GET /contact_renewal_reminders`

## Request

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

Returns a list of your ContactRenewalReminders.

## Query parameters

- `start_cursor` string
- `per_page` integer
- `filter` object
  - `contact_id` EqFilter
    - `eq` string, required
  - `contact_renewal_type_id` EqFilter
    - `eq` string, required
  - `active` BooleanFilter
    - `eq` 'true' | 'false', required
  - `contact_renewal_reminder_status` ContactRenewalReminderStatusFilter
    - `eq` 'ok' | 'overdue' | 'due_soon', required
  - `due_soon_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `last_sent_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, required
  - `next_due_at` union
    - object
      - `lt` string, required
    - object
      - `lte` string, required
    - object
      - `gt` string, required
    - object
      - `gte` string, 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'
  - `due_soon_at` 'asc' | 'desc'
  - `last_sent_at` '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
        - `contact_id` EqFilter
          - `eq` string, required
      - object
        - `contact_renewal_type_id` EqFilter
          - `eq` string, required
      - object
        - `active` BooleanFilter
          - `eq` 'true' | 'false', required
      - object
        - `contact_renewal_reminder_status` ContactRenewalReminderStatusFilter
          - `eq` 'ok' | 'overdue' | 'due_soon', required
      - object
        - `due_soon_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `last_sent_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, required
      - object
        - `next_due_at` union
          - object
            - `lt` string, required
          - object
            - `lte` string, required
          - object
            - `gt` string, required
          - object
            - `gte` string, 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
        - `due_soon_at` 'asc' | 'desc'
      - object
        - `last_sent_at` 'asc' | 'desc'
      - object
        - `next_due_at` 'asc' | 'desc'
      - object
        - `created_at` 'asc' | 'desc'
      - object
        - `updated_at` 'asc' | 'desc'
      - object
        - `id` 'asc' | 'desc'
  - `records` ContactRenewalReminderSummary[]
    - `id` integer
    - `active` boolean, required: Whether or not this Contact Renewal Reminder is active.
    - `contact_id` integer, required: The Id of the `Contact` associated with this Contact Renewal Reminder.
    - `contact_renewal_type_id` integer, required: The Id of the `ContactRenewalType` associated with this Contact Renewal Reminder.
    - `contact_renewal_reminder_status` 'due_soon' | 'overdue' | 'ok', required: The status of this Contact Renewal Reminder.
    - `contact_archived_at` string, date-time, nullable: The date and time at which this Renewal Reminder's `Contact` was archived.
    - `next_due_at` string, date-time: The date and time at which this Contact Renewal Reminder is next due. This attribute will only appear in responses if there is a next due date.
    - `last_sent_at` string, date-time, nullable: The date and time at which this Contact Renewal Reminder was last sent.
    - `due_soon_at` string, date-time, nullable: The date and time at which this Contact Renewal Reminder is considered due soon.
    - `due_soon_at_threshold_interval` integer, nullable: Used in conjunction with `due_soon_time_threshold_frequency`. Together they form a full due soon parameter eg; "1 week", "5 months", "10 years"
    - `due_soon_time_threshold_frequency` 'day' | 'week' | 'month' | 'year' | 'days' | 'weeks' | 'months' | 'years', nullable

## 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/contact_renewal_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)
