OnOffice icon

OnOffice

Consume OnOffice API

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.

Common scenarios where this node is beneficial include:

  • Fetching a list of properties for display or further processing in workflows.
  • Filtering estates by property type, marketing type, city, or postal code to target specific subsets.
  • Retrieving selected fields only to optimize data usage and performance.
  • Paginating through large datasets using limit and offset parameters.

Practical example:

  • A real estate agency wants to automatically pull all apartments for sale in a particular city every day to update their website listings.
  • A workflow that gathers estates filtered by commercial property type and sends alerts when new entries appear.

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, title, price, etc.
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.
Limit Maximum number of results to return (default 50).
Offset Offset for pagination of results (default 0).

Output

The output JSON contains an array of estate records matching the query. Each record includes the requested fields specified in the "Fields" property.

Output structure example (simplified):

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "12345",
      "objektnr_extern": "EXT-001",
      "objekttitel": "Modern Apartment Downtown",
      "vermarktungsart": "kauf",
      "objektart": "wohnung",
      "kaufpreis": 250000,
      "kaltmiete": null,
      "wohnflaeche": 80,
      "anzahl_zimmer": 3,
      "plz": "50667",
      "ort": "Köln",
      "strasse": "Hauptstraße",
      "hausnummer": "12",
      "objektbeschreibung": "Schöne, moderne Wohnung im Zentrum.",
      "erstellungsdatum": "2023-01-01",
      "aenderungsdatum": "2023-06-01",
      "status": "active"
    }
    // ... more records
  ],
  "total": 100,
  "status": { "errorcode": 0, "message": "OK" }
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API token credential for authenticating with the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Invalid JSON Data: When creating or updating estates, the "Data" property must be valid JSON. Invalid JSON will cause errors.
  • API Request Failed: Network issues or invalid credentials can cause request failures. Check API token validity and network connectivity.
  • Unsupported Resource or Operation: Selecting unsupported combinations will throw errors indicating the resource or operation is not supported.
  • API Errors: If the OnOffice API returns an error status, the node throws an error with the message from the API response.
  • Pagination Limits: Setting very high limits may cause performance issues or API throttling.

To resolve errors:

  • Verify all input parameters and JSON formatting.
  • Ensure API credentials are correctly configured.
  • Use appropriate filters and pagination to avoid large data loads.
  • Enable "Continue On Fail" if partial success is acceptable in workflows.

Links and References

  • OnOffice API Documentation (general reference for API capabilities)
  • n8n documentation on HTTP Request Node for understanding underlying HTTP calls
  • n8n community forums for troubleshooting and examples related to OnOffice integration

Discussion