Apex27 CRMInstall

Summary

Search across multiple Apex27 CRM resources using a search term and customizable filters to retrieve matching listings, contacts, issues, and tenancies.

Inputs

• term (required) — The search term string to query the global data.
• options.branchId — Optional branch ID to restrict the search to a specific branch.
• options.transactionType — Type of transaction to filter search results; defaults to 'sale'. Options include sale, rent, land, commercial sale, and commercial rent.
• options.includeArchived — Whether to include archived records in the search results; default is 'No' (0).
• options.searchListings — Whether to include listings in the search; default is 'Yes' (1).
• options.searchContacts — Whether to include contacts in the search; default is 'Yes' (1).
• options.searchIssues — Whether to include issues in the search; default is 'No' (0).
• options.searchTenancies — Whether to include tenancies in the search; default is 'No' (0).
• customHeaders — Array of custom HTTP headers to send with the search request, each with name and value.

Output shape

a JSON array of objects representing the matched records across the selected resource types (listings, contacts, issues, tenancies) based on the search parameters.

The search results include only resources enabled for searching via options flags. Including archived data depends on the includeArchived option. Custom headers affect the HTTP search request but do not alter the shape of the response.

Examples

Example 1: Search for 'Downtown Apartments' listings and contacts in branch 5 including archived data.

Set term='Downtown Apartments', options.branchId=5, options.includeArchived=1, options.searchListings=1, options.searchContacts=1, options.searchIssues=0, options.searchTenancies=0.

Links

• n8n community nodes installation guide