onOffice

Consume onOffice API

Actions10

Estate → Get

AI-generated

Overview

This node integrates with the onOffice API to retrieve real estate data. Specifically, the "Estate" resource with the "Get" operation allows users to fetch detailed information about a single estate by its unique ID. This is useful in scenarios where you want to automate workflows involving property management, real estate listings, or client inquiries by programmatically accessing up-to-date estate details.

For example, a real estate agency could use this node to automatically pull property details into their CRM system when a new inquiry arrives, ensuring agents have all relevant information at their fingertips without manual lookup.

Properties

Name Meaning
Estate ID The unique identifier of the estate to retrieve. This is a required string input.

Output

The node outputs JSON data representing the estate's details as returned by the onOffice API. The structure includes fields such as:

  • Id: The estate's unique identifier.
  • kaufpreis: Purchase price.
  • warmmiete: Warm rent (including heating).
  • kaltmiete: Cold rent (excluding heating).
  • objektart: Type of object (e.g., apartment, house).
  • objekttyp: Specific subtype of the object.
  • vermarktungsart: Marketing type.
  • wohnflaeche: Living area size.
  • nutzflaeche: Usable area size.
  • grundstuecksflaeche: Plot size.
  • plz: Postal code.
  • ort: City or location.
  • strasse: Street name.
  • hausnummer: House number.
  • objekttitel: Title or headline of the listing.
  • objektnr_extern: External object number.
  • lage: Location description.

If no matching estate is found, the output may contain an error message or an empty result set.

The node does not output binary data.

Dependencies

  • Requires an active onOffice API credential with an API token and secret.
  • The node makes HTTP POST requests to https://api.onoffice.de/api/stable/api.php.
  • HMAC SHA256 signing is used for request authentication, requiring the API token and secret.
  • Proper configuration of the onOffice API credentials in n8n is necessary before using this node.

Troubleshooting

  • No credentials provided: The node will throw an error if the onOffice API credentials are missing or invalid. Ensure that the API token and secret are correctly configured in n8n.
  • Invalid resource or operation: If the resource or operation parameters are incorrect, the node throws an error indicating the invalid combination.
  • API Error: If the onOffice API returns a non-200 status code, the node surfaces the error message from the API response. Check the API token validity, request parameters, and network connectivity.
  • Empty results: If the specified Estate ID does not exist, the node may return an empty array or no records. Verify the Estate ID is correct.
  • HMAC signature issues: Since requests require HMAC signing, ensure the API secret is accurate; otherwise, authentication will fail.

Links and References

Discussion