ImobziInstall

Summary

Retrieve multiple lease (Locacao) records from the Imobzi API applying optional filters and pagination to control the number of records returned.

Inputs

• recordLimit — Set the maximum number of lease records to return, with options ranging from 50 to all available (up to 5000), handling auto-pagination accordingly.
• leaseFilters — Specify filtering criteria as a collection; currently supports filtering by 'Smart List' status such as active, expired, finished, pending, and other predefined lease states.

Output shape

A list of lease records, each represented as a JSON object, limited by the specified recordLimit and filtered by any provided leaseFilters.

This operation performs automatic pagination to fetch up to the specified 'recordLimit' of leases, defaulting to 50 if not specified. The leaseFilters parameter accepts a 'smart_list' value to filter leases by predefined statuses. Returned data corresponds directly to the leases endpoint and is provided as individual JSON items per lease.

Examples

Example 1: Fetch up to 100 active leases.

Set 'recordLimit' to 100 and 'leaseFilters.smart_list' to 'active'.