Rentals

Rental agreements, renewal reminders (T-60 / 45 / 30) and renewal deals.

GET/v1/rental-agreements

List rental agreements

Within the caller’s rentals scope (agreements of their rental deals for own / team). Sort keys: end_date (default), start_date, created_at, rent_amount.

Access: API key or member session. Permission rentals.view.

Parameters

cursorquery: string
Opaque cursor from the previous page (`meta.next_cursor`).
limitquery: integer
Page size, 1–200.
sortquery: string
Comma list of sort keys, "-" prefix for descending, e.g. -received_at.
statusquery: AgreementStatus
expiring_withinquery: integer
Active or expiring agreements ending within this many days.
property_idquery: Id
Opaque record id.
deal_idquery: Id
Opaque record id.
lead_idquery: Id
Opaque record id.

Response · 200

datarequired: array of RentalAgreement
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/rental-agreements' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "draft",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string"
      },
      "deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string",
        "owner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      },
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "end_date": "2026-10-06",
      "rent_amount": 850000000,
      "deposit_amount": 850000000,
      "maintenance": {
        "amount": 850000000,
        "period": "monthly"
      },
      "escalation_pct": "string",
      "lock_in_months": 0,
      "lock_in_ends_on": "2026-10-06",
      "notice_months": 0,
      "rent_due_day": 0,
      "police_verification": "pending",
      "agreement_type": "notarised",
      "has_document": true,
      "document_scan_status": "pending",
      "renewal_reminder_on": "2026-10-06",
      "days_left": 0,
      "renewal_deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "stage": "negotiation"
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "capabilities": {
        "edit": true,
        "delete": true,
        "renew": true
      }
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/rental-agreements

Record a rental agreement

Schedules the renewal reminders (T-60 / T-45 / T-30) from the end date.

Access: API key or member session. Permission rentals.create.

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

property_id: Id or null
Opaque record id.
deal_id: Id or null
Opaque record id.
owner_id: Id or null
Opaque record id.
lead_id: Id or null
Opaque record id.
maintenance_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_period: MaintenancePeriod or null
landlord_contact_id: Id
Opaque record id.
tenant_contact_id: Id
Opaque record id.
start_date: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
end_date: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rent_amount: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
deposit_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
escalation_pct: DecimalInput or null
A decimal such as 2 or 2.5 (number or string).
lock_in_months: integer or null
notice_months: integer or null
rent_due_day: integer or null
police_verification: PoliceVerificationStatus or null
agreement_type: AgreementType or null
status: "draft" | "active" | "renewed" | "terminated"

Response · 201

datarequired: RentalAgreement
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"property_id":"cmusrceel0000q7kaafxqi1om","deal_id":"cmusrceel0000q7kaafxqi1om","owner_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","maintenance_amount":0,"maintenance_period":"monthly","landlord_contact_id":"cmusrceel0000q7kaafxqi1om","tenant_contact_id":"cmusrceel0000q7kaafxqi1om","start_date":"2026-10-06","end_date":"2026-10-06","rent_amount":0,"deposit_amount":0,"escalation_pct":0,"lock_in_months":0,"notice_months":0,"rent_due_day":1,"police_verification":"pending","agreement_type":"notarised","status":"draft"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "landlord": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "tenant": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "start_date": "2026-10-06",
    "end_date": "2026-10-06",
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance": {
      "amount": 850000000,
      "period": "monthly"
    },
    "escalation_pct": "string",
    "lock_in_months": 0,
    "lock_in_ends_on": "2026-10-06",
    "notice_months": 0,
    "rent_due_day": 0,
    "police_verification": "pending",
    "agreement_type": "notarised",
    "has_document": true,
    "document_scan_status": "pending",
    "renewal_reminder_on": "2026-10-06",
    "days_left": 0,
    "renewal_deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "stage": "negotiation"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "delete": true,
      "renew": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/rental-agreements/{id}

A rental agreement

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalAgreement
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/rental-agreements/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "landlord": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "tenant": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "start_date": "2026-10-06",
    "end_date": "2026-10-06",
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance": {
      "amount": 850000000,
      "period": "monthly"
    },
    "escalation_pct": "string",
    "lock_in_months": 0,
    "lock_in_ends_on": "2026-10-06",
    "notice_months": 0,
    "rent_due_day": 0,
    "police_verification": "pending",
    "agreement_type": "notarised",
    "has_document": true,
    "document_scan_status": "pending",
    "renewal_reminder_on": "2026-10-06",
    "days_left": 0,
    "renewal_deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "stage": "negotiation"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "delete": true,
      "renew": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/rental-agreements/{id}

Update a rental agreement

A new end date (or reactivation) restarts the renewal reminders.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

property_id: Id or null
Opaque record id.
owner_id: Id or null
Opaque record id.
lead_id: Id or null
Opaque record id.
maintenance_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
maintenance_period: MaintenancePeriod or null
landlord_contact_id: Id
Opaque record id.
tenant_contact_id: Id
Opaque record id.
start_date: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
end_date: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rent_amount: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
deposit_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
escalation_pct: DecimalInput or null
A decimal such as 2 or 2.5 (number or string).
lock_in_months: integer or null
notice_months: integer or null
rent_due_day: integer or null
agreement_type: AgreementType or null
status: "draft" | "active" | "renewed" | "terminated"

Response · 200

datarequired: RentalAgreement
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/rental-agreements/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"property_id":"cmusrceel0000q7kaafxqi1om","owner_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","maintenance_amount":0,"maintenance_period":"monthly","landlord_contact_id":"cmusrceel0000q7kaafxqi1om","tenant_contact_id":"cmusrceel0000q7kaafxqi1om","start_date":"2026-10-06","end_date":"2026-10-06","rent_amount":0,"deposit_amount":0,"escalation_pct":0,"lock_in_months":0,"notice_months":0,"rent_due_day":1,"agreement_type":"notarised","status":"draft"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "landlord": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "tenant": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "start_date": "2026-10-06",
    "end_date": "2026-10-06",
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance": {
      "amount": 850000000,
      "period": "monthly"
    },
    "escalation_pct": "string",
    "lock_in_months": 0,
    "lock_in_ends_on": "2026-10-06",
    "notice_months": 0,
    "rent_due_day": 0,
    "police_verification": "pending",
    "agreement_type": "notarised",
    "has_document": true,
    "document_scan_status": "pending",
    "renewal_reminder_on": "2026-10-06",
    "days_left": 0,
    "renewal_deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "stage": "negotiation"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "delete": true,
      "renew": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/rental-agreements/{id}

Delete a rental agreement

Removes the record (the audit log keeps a copy). Prefer terminating an agreement that ran.

Access: API key or member session. Permission rentals.delete.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/rental-agreements/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/rental-agreements/{id}/document

Download the agreement document

A 60-second signed URL; every open is audited.

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: DownloadUrl
A short-lived signed download URL.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/rental-agreements/{id}/document' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/rental-agreements/{id}/document

Attach the signed agreement

Replaces the previous document.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

keyrequired: string
filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: RentalAgreement
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/document' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"key":"string","filename":"string","content_type":"string","size":1}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "draft",
    "property": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref_code": "string",
      "title": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string",
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      }
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string"
    },
    "landlord": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "tenant": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "start_date": "2026-10-06",
    "end_date": "2026-10-06",
    "rent_amount": 850000000,
    "deposit_amount": 850000000,
    "maintenance": {
      "amount": 850000000,
      "period": "monthly"
    },
    "escalation_pct": "string",
    "lock_in_months": 0,
    "lock_in_ends_on": "2026-10-06",
    "notice_months": 0,
    "rent_due_day": 0,
    "police_verification": "pending",
    "agreement_type": "notarised",
    "has_document": true,
    "document_scan_status": "pending",
    "renewal_reminder_on": "2026-10-06",
    "days_left": 0,
    "renewal_deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "stage": "negotiation"
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "delete": true,
      "renew": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/rental-agreements/{id}/document/presign

Start the agreement document upload

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: PresignedUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/document/presign' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":1}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "max_bytes": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/rental-agreements/{id}/renewal

A rental deal in negotiation with the escalated rent (rounded to the rupee), the same parties, listing and commission terms. An open renewal deal of this agreement is returned instead of a second one.

Access: API key with deals:write, or a member session. Permission deals.create.

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

escalation_pct: DecimalInput or null
Default: the agreement’s escalation.
owner_id: Id or null
Opaque record id.

Response · 200

datarequired: object
data.dealrequired: DealDetail
data.createdrequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/renewal' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"escalation_pct":0,"owner_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "D-1024",
      "number": 0,
      "type": "sale",
      "kind": "resale",
      "stage": "negotiation",
      "title": "string",
      "contact": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string"
      },
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref_code": "string",
        "title": "string"
      },
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "unit": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "unit_no": "string"
      },
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "agreed_value": 850000000,
      "token_amount": 850000000,
      "token_date": "2026-10-06",
      "agreement_date": "2026-10-06",
      "registration_date": "2026-10-06",
      "handover_date": "2026-10-06",
      "commission_amount": 850000000,
      "commission_received": 850000000,
      "lost_reason": "string",
      "closed_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "parties": [
        {
          "role": "buyer",
          "contact": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          }
        }
      ],
      "token_mode": "upi",
      "commission_basis": "string",
      "commission_rate": "string",
      "commission": {
        "sides": [
          {
            "side": "buyer",
            "basis": "percent",
            "rate": "string",
            "amount": 850000000,
            "expected": 850000000
          }
        ],
        "gross": 850000000,
        "co_broker": {
          "contact": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "share_pct": "string",
          "amount": 850000000
        },
        "net": 850000000,
        "received": 850000000,
        "outstanding": 850000000
      },
      "splits": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "member": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "role": "sourcing",
          "share_pct": "string",
          "amount": 850000000
        }
      ],
      "documents": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "kind": "token_receipt",
          "name": "string",
          "content_type": "string",
          "size": 0,
          "receipt_id": "cmusrceel0000q7kaafxqi1om",
          "uploaded_by": {
            "id": "cmusrceel0000q7kaafxqi1om",
            "name": "string"
          },
          "uploaded_at": "2026-10-06T05:30:00.000Z",
          "scan_status": "pending"
        }
      ],
      "notes": "string",
      "renewal_of_agreement_id": "cmusrceel0000q7kaafxqi1om",
      "capabilities": {
        "edit": true,
        "delete": true,
        "approve": true,
        "commission": "hidden",
        "splits": "hidden",
        "record_receipts": true,
        "payouts": true
      }
    },
    "created": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

{ "data": [ { "id": "cmusrceel0000q7kaafxqi1om", "status": "draft", "property": { "id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string" }, "deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "title": "string", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string" }, "landlord": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "tenant": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "start_date": "2026-10-06", "end_date": "2026-10-06", "rent_amount": 850000000, "deposit_amount": 850000000, "maintenance": { "amount": 850000000, "period": "monthly" }, "escalation_pct": "string", "lock_in_months": 0, "lock_in_ends_on": "2026-10-06", "notice_months": 0, "rent_due_day": 0, "police_verification": "pending", "agreement_type": "notarised", "has_document": true, "document_scan_status": "pending", "renewal_reminder_on": "2026-10-06", "days_left": 0, "renewal_deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "stage": "negotiation" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "capabilities": { "edit": true, "delete": true, "renew": true } } ], "meta": { "next_cursor": "string", "has_more": true } }

curl -X POST 'https://api.propzolo.com/v1/rental-agreements' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"property_id":"cmusrceel0000q7kaafxqi1om","deal_id":"cmusrceel0000q7kaafxqi1om","owner_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","maintenance_amount":0,"maintenance_period":"monthly","landlord_contact_id":"cmusrceel0000q7kaafxqi1om","tenant_contact_id":"cmusrceel0000q7kaafxqi1om","start_date":"2026-10-06","end_date":"2026-10-06","rent_amount":0,"deposit_amount":0,"escalation_pct":0,"lock_in_months":0,"notice_months":0,"rent_due_day":1,"police_verification":"pending","agreement_type":"notarised","status":"draft"}'

{ "data": { "id": "cmusrceel0000q7kaafxqi1om", "status": "draft", "property": { "id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string" }, "deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "title": "string", "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } }, "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string" }, "landlord": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "tenant": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "start_date": "2026-10-06", "end_date": "2026-10-06", "rent_amount": 850000000, "deposit_amount": 850000000, "maintenance": { "amount": 850000000, "period": "monthly" }, "escalation_pct": "string", "lock_in_months": 0, "lock_in_ends_on": "2026-10-06", "notice_months": 0, "rent_due_day": 0, "police_verification": "pending", "agreement_type": "notarised", "has_document": true, "document_scan_status": "pending", "renewal_reminder_on": "2026-10-06", "days_left": 0, "renewal_deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string", "stage": "negotiation" }, "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "capabilities": { "edit": true, "delete": true, "renew": true } }, "meta": {} }

curl -X PATCH 'https://api.propzolo.com/v1/rental-agreements/{id}' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"property_id":"cmusrceel0000q7kaafxqi1om","owner_id":"cmusrceel0000q7kaafxqi1om","lead_id":"cmusrceel0000q7kaafxqi1om","maintenance_amount":0,"maintenance_period":"monthly","landlord_contact_id":"cmusrceel0000q7kaafxqi1om","tenant_contact_id":"cmusrceel0000q7kaafxqi1om","start_date":"2026-10-06","end_date":"2026-10-06","rent_amount":0,"deposit_amount":0,"escalation_pct":0,"lock_in_months":0,"notice_months":0,"rent_due_day":1,"agreement_type":"notarised","status":"draft"}'

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/document' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"key":"string","filename":"string","content_type":"string","size":1}'

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/document/presign' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Content-Type: application/json' \ -d '{"filename":"string","content_type":"string","size":1}'

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/renewal' \ -H 'Authorization: Bearer pz_live_…' \ -H 'Idempotency-Key: 6c0f1d3e-…' \ -H 'Content-Type: application/json' \ -d '{"escalation_pct":0,"owner_id":"cmusrceel0000q7kaafxqi1om"}'

{ "data": { "deal": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "D-1024", "number": 0, "type": "sale", "kind": "resale", "stage": "negotiation", "title": "string", "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "lead": { "id": "cmusrceel0000q7kaafxqi1om", "ref": "string" }, "property": { "id": "cmusrceel0000q7kaafxqi1om", "ref_code": "string", "title": "string" }, "project": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "unit": { "id": "cmusrceel0000q7kaafxqi1om", "unit_no": "string" }, "owner": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "agreed_value": 850000000, "token_amount": 850000000, "token_date": "2026-10-06", "agreement_date": "2026-10-06", "registration_date": "2026-10-06", "handover_date": "2026-10-06", "commission_amount": 850000000, "commission_received": 850000000, "lost_reason": "string", "closed_at": "2026-10-06T05:30:00.000Z", "created_at": "2026-10-06T05:30:00.000Z", "updated_at": "2026-10-06T05:30:00.000Z", "parties": [ { "role": "buyer", "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" } } ], "token_mode": "upi", "commission_basis": "string", "commission_rate": "string", "commission": { "sides": [ { "side": "buyer", "basis": "percent", "rate": "string", "amount": 850000000, "expected": 850000000 } ], "gross": 850000000, "co_broker": { "contact": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "share_pct": "string", "amount": 850000000 }, "net": 850000000, "received": 850000000, "outstanding": 850000000 }, "splits": [ { "id": "cmusrceel0000q7kaafxqi1om", "member": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "role": "sourcing", "share_pct": "string", "amount": 850000000 } ], "documents": [ { "id": "cmusrceel0000q7kaafxqi1om", "kind": "token_receipt", "name": "string", "content_type": "string", "size": 0, "receipt_id": "cmusrceel0000q7kaafxqi1om", "uploaded_by": { "id": "cmusrceel0000q7kaafxqi1om", "name": "string" }, "uploaded_at": "2026-10-06T05:30:00.000Z", "scan_status": "pending" } ], "notes": "string", "renewal_of_agreement_id": "cmusrceel0000q7kaafxqi1om", "capabilities": { "edit": true, "delete": true, "approve": true, "commission": "hidden", "splits": "hidden", "record_receipts": true, "payouts": true } }, "created": true }, "meta": {} }