Rent Reminders

List rent reminders

List all rent reminders for a lease, with optional status filter.

Permissions required: leases:read

get/leases/{lease_id}/rent-reminders

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/rent-reminders
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Query parameters

status'DRAFT' | 'SENT' | 'ACKNOWLEDGED'

Response

List of rent reminders

idstring uuid
lease_idstring uuid
reminder_type'FRIENDLY' | 'FORMAL_NOTICE' | 'PAYMENT_ORDER'
sent_datestring date nullable
due_amountnumber
periods_coveredobject[]
delivery_method'EMAIL' | 'LETTER' | 'LRAR'
tracking_numberstring nullable
status'DRAFT' | 'SENT' | 'ACKNOWLEDGED'
document_urlstring nullable
notesstring nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.