FairePlace Property Management API
string · uuid · requiredstring · uuid · required string · uuid · requiredstring · uuid · requiredstring · enum · requiredstring · date-time · requiredstring · uuid · requiredobject | nullobject | nullstring | null
string · uuid · requiredstring · uuid · requiredstring · uuid · required string · uuid · requiredstring · uuid · requiredstring · enum · requiredstring · date-time · requiredstring · uuid · requiredobject | nullobject | nullstring | null
List amendment history
GET
https://api.faireplace.com/api
/leases/{lease_id}/amendments/{amendment_id}/history
Returns the complete audit trail for an amendment. Entries are automatically created by the system when changes occur (status changes, content modifications, validation changes, signature updates, document additions).
Read-only — history entries cannot be created, updated, or deleted via API.
path Parameters
lease_idamendment_idList amendment history › Responses
List of history entries
object[]
Audit trail entry for an amendment change (read-only)
idamendment_idchange_typeType of change recorded
Enum values:
STATUS_CHANGE
CONTENT_MODIFICATION
VALIDATION_CHANGE
SIGNATURE_UPDATE
DOCUMENT_ADDITION
Example: STATUS_CHANGE
change_dateperformed_byID of the user who performed the change
previous_valuesPrevious state as JSON
new_valuesNew state as JSON
change_reasonGet a specific history entry
GET
https://api.faireplace.com/api
/leases/{lease_id}/amendments/{amendment_id}/history/{entry_id}
path Parameters
lease_idamendment_identry_idGet a specific history entry › Responses
History entry details
Audit trail entry for an amendment change (read-only)
idamendment_idchange_typeType of change recorded
Enum values:
STATUS_CHANGE
CONTENT_MODIFICATION
VALIDATION_CHANGE
SIGNATURE_UPDATE
DOCUMENT_ADDITION
Example: STATUS_CHANGE
change_dateperformed_byID of the user who performed the change
previous_valuesPrevious state as JSON
new_valuesNew state as JSON
change_reason