Actions15
Overview
This node integrates with the OnOffice API to manage real estate data and related resources. Specifically, for the Estate - Get Many operation, it retrieves multiple estate records from the OnOffice system based on various filtering criteria and pagination options.
Typical use cases include:
- Fetching a list of properties for display or further processing.
- Filtering estates by property type (e.g., house, apartment), marketing type (for sale or rent), city, or postal code.
- Retrieving specific fields of estate data to optimize performance and reduce payload size.
- Implementing pagination through limit and offset parameters to handle large datasets.
For example, a real estate agency could use this node to pull all apartments for sale in a particular city, limiting results to 50 per request, and only retrieving key details like title, price, and living space.
Properties
| Name | Meaning |
|---|---|
| Fields | Select which estate fields to return. Options include: ID, External Object Number, Title, Type of Marketing, Property Type, Purchase Price, Cold Rent, Living Space, Number of Rooms, Postal Code, City, Street, House Number, Description, Creation Date, Last Change Date, Status. Default includes common fields like ID, external number, title, marketing type, property type, price, rent, living space, and rooms. |
| Filter by Property Type | Filter estates by property type. Options: Any (no filter), House, Apartment, Land, Commercial. |
| Filter by Marketing Type | Filter estates by marketing type. Options: Any (no filter), For Sale, For Rent. |
| Filter by City | Filter estates by city name (string). |
| Filter by Postal Code | Filter estates by postal code (string). |
| Advanced Filter | Additional advanced filter criteria as a string, merged with other filters for more complex queries. |
| Limit | Maximum number of estate records to return (number). Default is 50. |
| Offset | Offset for pagination to skip a number of records (number). Default is 0. |
Output
The output JSON contains:
success: Boolean indicating if the API call was successful.resourceType: The resource queried, here always"estate".operation: The operation performed, here"getMany".data: An array of estate records matching the query. Each record includes the requested fields.total(optional): Total count of matching records available in the backend (if provided by API).status/message: Status information or messages from the API.
If an error occurs, the output will contain error details including message and optionally raw API response data.
No binary data is returned by this operation.
Dependencies
- Requires an API token and secret credential for authenticating with the OnOffice API.
- The node makes HTTP POST requests to the OnOffice API endpoint at
https://api.onoffice.de/api/latest/api.php. - HMAC signature generation is used for request authentication.
- Proper configuration of the API credentials in n8n is necessary.
Troubleshooting
- Invalid JSON in Data Field: When creating or updating estates, the "Data" input must be valid JSON. Invalid JSON will cause an error.
- API Request Failed: Network issues, invalid credentials, or API downtime can cause request failures. Check API token/secret and network connectivity.
- Unsupported Resource or Operation: Selecting a resource or operation not supported by the node will throw an error.
- Empty or No Results: Filters may be too restrictive; try loosening filter criteria or increasing the limit.
- Permission Errors: Ensure the API credentials have sufficient permissions to read estate data.
Links and References
- OnOffice API Documentation (general reference, actual URL may vary)
- n8n documentation on Creating Custom Nodes
- HMAC Authentication concepts: https://en.wikipedia.org/wiki/HMAC
This summary focuses exclusively on the "Estate" resource and "Get Many" operation as requested.