Amendment History

List amendment 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.

get/leases/{lease_id}/amendments/{amendment_id}/history

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/amendments/{amendment_id}/history
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
amendment_idstring uuid required

Response

List of history entries

idstring uuid required
amendment_idstring uuid required
change_type'STATUS_CHANGE' | 'CONTENT_MODIFICATION' | 'VALIDATION_CHANGE' | 'SIGNATURE_UPDATE' | 'DOCUMENT_ADDITION' required

Type of change recorded

change_datestring date-time required
previous_valuesobject nullable

Previous state as JSON

new_valuesobject nullable

New state as JSON

change_reasonstring nullable
performed_bystring uuid required

ID of the user who performed the change

Example response

[
  {
    "change_type": "STATUS_CHANGE"
  }
]

Changes

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