Contact Renewal Reminders

List Contact Renewal Reminders

Changed on

Returns a list of your ContactRenewalReminders.

get/contact_renewal_reminders

Request

Query parameters

start_cursorstring

The start cursor for Keyset pagination.

per_pageinteger

The number of records per page to return.

The fields, operations, and values to filter the records by.

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'

The fields and direction to sort the results by.

Response

OK

start_cursorstring nullable

The current start cursor of the records returned.

next_cursorstring nullable

The next cursor to retrieve the next page of records.

per_pageinteger

The maximum number of records returned.

estimated_remaining_countinteger

The number of remaining records including the returned records, up to a maximum of 500.

Example response

{
  "records": [
    {
      "contact_archived_at": "2023-03-14T13:46:27-06:00"
    }
  ]
}

Changes