List Contact Renewal Reminders

Returns a list of your ContactRenewalReminders.

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.
- contact_id object
  eq string required
- contact_renewal_type_id object
  eq string required
- active object
  eq string required
  Possible values: [true, false]
  Default value: true
- contact_renewal_reminder_status object
  eq string required
  Possible values: [ok, overdue, due_soon]
- due_soon_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- last_sent_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- next_due_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- created_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
- updated_at object
  oneOf
  MOD1
  MOD2
  MOD3
  MOD4
  lt string required
sort object
The fields and direction to sort the results by.
- id string
  Possible values: [asc, desc]
  Default value: desc
- due_soon_at string
  Possible values: [asc, desc]
- last_sent_at string
  Possible values: [asc, desc]
- next_due_at string
  Possible values: [asc, desc]
- created_at string
  Possible values: [asc, desc]
- updated_at string
  Possible values: [asc, desc]

Responses

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
MOD6
MOD7
MOD8
MOD9
contact_id object
eq string
sorted_by object[]
The sorts applied to the returned record set.
anyOf
MOD1
MOD2
MOD3
MOD4
MOD5
MOD6
due_soon_at string
Possible values: [asc, desc]
records ContactRenewalReminder[]
id integer
active boolean
Whether or not this Contact Renewal Reminder is active.
contact_id integer
The Id of the Contact associated with this Contact Renewal Reminder.
contact_renewal_type_id integer
The Id of the ContactRenewalType associated with this Contact Renewal Reminder.
contact_renewal_reminder_status string
Possible values: [due_soon, overdue, ok]
The status of this Contact Renewal Reminder.
contact_archived_at date-time
The date and time at which this Renewal Reminder's Contact was archived.
next_due_at 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 date-time
The date and time at which this Contact Renewal Reminder was last sent.
due_soon_at date-time
The date and time at which this Contact Renewal Reminder is considered due soon.
due_soon_at_threshold_interval integer
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 string
Possible values: [day, week, month, year, days, weeks, months, years]

{
  "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-11-18",
      "last_sent_at": "2024-11-18",
      "due_soon_at": "2024-11-18",
      "due_soon_at_threshold_interval": 0,
      "due_soon_time_threshold_frequency": "day"
    }
  ]
}

The format or parameters of the request was invalid

application/json

Schema
Example (from schema)

Schema

errors object
type
items 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"
}