Apex27 CRMInstall

Summary

Retrieve multiple real estate listings from Apex27 CRM matching specified filter criteria, optional inclusions, and pagination settings.

Inputs

• filters — Various optional filters to narrow down listings by attributes such as Branch ID, Contact ID, Email, UUID, External ID, Transaction Type (sale, rent, land, commercial sale, commercial rent), minimum bedrooms, minimum bathrooms, minimum and maximum price, city, website status, main search region ID, archived status, active tenancies, minimum created/updated datetime, minimum updated datetime, and options to include related contacts, images, offers, valuations, or rooms.
• page — The page number for paginated results, minimum value is 1. Defaults to 1.
• pageSize — The number of listings per page to retrieve, with allowed values between 25 and 250. Defaults to 25.
• customHeaders — Additional HTTP headers to send with the API request, specified as key-value pairs.

Output shape

an array of listing objects potentially including related contacts, images, offers, valuations, and rooms depending on inclusion filters

Results are paginated based on page and pageSize inputs. Each listing object may include nested arrays of contacts, images, offers, valuations, and rooms if corresponding include options are set to 'Yes'.

Examples

Example 1: Retrieve all active sale listings with at least 2 bedrooms and a minimum price of 100,000 including images and valuations, on page 1 with 50 listings per page.

Set filters: transactionType = sale, minBeds = 2, minPrice = 100000, includeImages = Yes, includeValuations = Yes. Set page = 1, pageSize = 50.

Links

• n8n community nodes installation guide