onOffice icon

onOffice

Consume onOffice API

Actions14

Overview

This node integrates with the onOffice API to retrieve real estate data. Specifically, the Estate - Get All operation fetches multiple estate records from the onOffice system, supporting filtering and sorting options. It is useful for workflows that need to bulk query real estate listings based on criteria such as estate number, title, city, or zip code.

Typical use cases include:

  • Synchronizing estate listings into a CRM or database.
  • Generating reports or dashboards of available properties.
  • Filtering estates dynamically based on user input or other workflow data.

For example, you could retrieve up to 50 estates located in a specific city, sorted by price ascending, to display current market offerings.

Properties

Name Meaning
Limit Max number of estate results to return (minimum 1, default 50).
Filters Collection of filters to narrow down estates:
  Estate Number Filter estates by their reference number.
  Estate Number Field Name API field name used for estate number filtering (default: objektnr_extern).
  Title Filter estates by title.
  Title Field Name API field name used for title filtering (default: objekttitel).
  City Filter estates by city.
  City Field Name API field name used for city filtering (default: ort).
  Zip Code Filter estates by zip code.
  Zip Code Field Name API field name used for zip code filtering (default: plz).
Options Additional options for result customization:
  Sort by Field to sort results by. Options: Estate ID, Title, Price, City. Default: Estate ID (Id).
  Sort Direction Sort order direction. Options: Ascending, Descending. Default: Ascending.

Output

The output is an array of JSON objects representing estate records matching the query. Each object contains fields returned by the API, including but not limited to:

  • Id: Unique estate identifier.
  • kaufpreis: Purchase price.
  • warmmiete, kaltmiete: Rental prices.
  • objektart, objekttyp: Type/category of the estate.
  • vermarktungsart: Marketing type.
  • wohnflaeche, nutzflaeche, grundstuecksflaeche: Various area measurements.
  • plz: Zip code.
  • ort: City.
  • strasse, hausnummer: Street address.
  • objekttitel: Title of the estate.
  • objektnr_extern: External estate number.
  • lage: Location description.

Each output item also includes a resourceType property set to "estate" to identify the resource type.

If no results are found or the response cannot be parsed, the node outputs a success message indicating no results.

Dependencies

  • Requires an API key credential for authenticating with the onOffice API.
  • The node makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • Uses HMAC SHA256 signing for request authentication, requiring both an API token and secret.
  • No additional external dependencies beyond standard n8n HTTP request helpers.

Troubleshooting

  • No credentials provided: The node will throw an error if the required API authentication token and secret are missing. Ensure credentials are configured properly.
  • Invalid resource or operation: If the resource or operation parameters are incorrect, the node throws an error. Verify that "Estate" and "Get All" are selected.
  • API errors: If the API returns a non-200 status code, the node surfaces the error message. Common causes include invalid tokens, expired credentials, or malformed requests.
  • No results found: This is not an error but indicates that no estates matched the filter criteria.
  • Field name mismatches: Customizing filter field names incorrectly may cause no matches. Use default field names unless you know the API schema well.

To resolve issues:

  • Double-check API credentials.
  • Confirm correct resource and operation selection.
  • Review filter values and field names.
  • Inspect raw API responses included in output for debugging.

Links and References

Discussion