List Contact Renewal Reminders

GET 
https://secure.fleetio.com/api/contact_renewal_reminders

Returns a list of your ContactRenewalReminders.

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.
contact_id object
eqstringrequired
contact_renewal_type_id object
eqstringrequired
active object
eqstringrequired
Possible values: [true, false]
Default value: true
contact_renewal_reminder_status object
eqstringrequired
Possible values: [ok, overdue, due_soon]
due_soon_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
last_sent_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
next_due_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
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

due_soon_atSortAscDesc (string)

Possible values: [asc, desc]

last_sent_atSortAscDesc (string)

Possible values: [asc, 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
contact_id object
eqstringrequired
MOD2
contact_renewal_type_id object
eqstringrequired
MOD3
active object
eqstringrequired
Possible values: [true, false]
Default value: true
MOD4
contact_renewal_reminder_status object
eqstringrequired
Possible values: [ok, overdue, due_soon]
MOD5
due_soon_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD6
last_sent_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD7
next_due_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD8
created_at object
oneOf
LtFilter
ltstringrequired
LteFilter
ltestringrequired
GtFilter
gtstringrequired
GteFilter
gtestringrequired
MOD9
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
due_soon_atSortAscDesc (string)
Possible values: [asc, desc]
MOD2
last_sent_atSortAscDesc (string)
Possible values: [asc, desc]
MOD3
next_due_atSortAscDesc (string)
Possible values: [asc, desc]
MOD4
created_atSortAscDesc (string)
Possible values: [asc, desc]
MOD5
updated_atSortAscDesc (string)
Possible values: [asc, desc]
MOD6
idSortAscDesc (string)
Possible values: [asc, desc]
]
records ContactRenewalReminder[]
Array [
idinteger
activebooleanrequired
Whether or not this Contact Renewal Reminder is active.
contact_idintegerrequired
The Id of the Contact associated with this Contact Renewal Reminder.
contact_renewal_type_idintegerrequired
The Id of the ContactRenewalType associated with this Contact Renewal Reminder.
contact_renewal_reminder_statusstringrequired
The status of this Contact Renewal Reminder.
Possible values: [due_soon, overdue, ok]
contact_archived_atdate-timenullable
The date and time at which this Renewal Reminder's Contact was archived.
Example: 2023-03-14T13:46:27-06:00
next_due_atdate-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_atdate-timenullable
The date and time at which this Contact Renewal Reminder was last sent.
due_soon_atdate-timenullable
The date and time at which this Contact Renewal Reminder is considered due soon.
due_soon_at_threshold_intervalintegernullable
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_frequencystringnullable
Possible values: [day, week, month, year, days, weeks, months, years]
]

Example (auto)

{
  "start_cursor": "string",
  "next_cursor": "string",
  "per_page": 0,
  "estimated_remaining_count": 0,
  "filtered_by": [
    {
      "contact_id": {
        "eq": "string"
      }
    },
    {
      "contact_renewal_type_id": {
        "eq": "string"
      }
    },
    {
      "active": {
        "eq": "true"
      }
    },
    {
      "contact_renewal_reminder_status": {
        "eq": "ok"
      }
    },
    {
      "due_soon_at": {
        "lt": "string"
      }
    },
    {
      "last_sent_at": {
        "lt": "string"
      }
    },
    {
      "next_due_at": {
        "lt": "string"
      }
    },
    {
      "created_at": {
        "lt": "string"
      }
    },
    {
      "updated_at": {
        "lt": "string"
      }
    }
  ],
  "sorted_by": [
    {
      "due_soon_at": "asc"
    },
    {
      "last_sent_at": "asc"
    },
    {
      "next_due_at": "asc"
    },
    {
      "created_at": "asc"
    },
    {
      "updated_at": "asc"
    },
    {
      "id": "asc"
    }
  ],
  "records": [
    {
      "id": 0,
      "active": true,
      "contact_id": 0,
      "contact_renewal_type_id": 0,
      "contact_renewal_reminder_status": "due_soon",
      "contact_archived_at": "2023-03-14T13:46:27-06:00",
      "next_due_at": "2024-07-29T15:51:28.071Z",
      "last_sent_at": "2024-07-29T15:51:28.071Z",
      "due_soon_at": "2024-07-29T15:51:28.071Z",
      "due_soon_at_threshold_interval": 0,
      "due_soon_time_threshold_frequency": "day"
    }
  ]
}

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

contact_ideq

contact_renewal_type_ideq

activeeq

contact_renewal_reminder_statuseq

due_soon_atltltegtgte

last_sent_atltltegtgte

next_due_atltltegtgte

created_atltltegtgte

updated_atltltegtgte

sort — query

id---ascdesc

due_soon_at---ascdesc

last_sent_at---ascdesc

next_due_at---ascdesc

created_at---ascdesc

updated_at---ascdesc

ResponseClear

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