OnOffice

Consume OnOffice API

Actions12

Estate → Get

AI-generated

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, the Estate - Get operation retrieves detailed information about a single estate record by its ID. It allows users to specify which fields of the estate they want to retrieve, enabling tailored data extraction.

Common scenarios where this node is beneficial include:

  • Fetching detailed property information for display or processing in workflows.
  • Integrating OnOffice estate data into CRM systems or reporting tools.
  • Automating updates or validations based on specific estate attributes.

For example, you might use this node to get an estate's title and external number by specifying those fields, then use that data downstream in your automation.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve. This is required.
Fields Comma-separated list of estate fields to return (e.g., Id,objekttitel,objektnr_extern). Defaults to Id,objekttitel,objektnr_extern.

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "get".
  • data: An array of records containing the requested estate fields.
  • total (optional): Total count of records returned (mainly relevant for multi-record queries).
  • message (optional): Status message from the API.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "get",
  "data": [
    {
      "Id": "12345",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT-6789"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • Needs proper configuration of these credentials within n8n.
  • Uses HTTPS POST requests to the OnOffice API endpoint: https://api.onoffice.de/api/v1.

Troubleshooting

  • Invalid JSON in Fields or Data: If the fields parameter or any JSON input is malformed, the node throws an error. Ensure all JSON inputs are valid.
  • Missing or Incorrect ID: The ID property is mandatory for the get operation. Omitting it or providing an invalid ID will cause errors.
  • API Authentication Errors: If the API token or secret is incorrect or missing, authentication will fail. Verify credentials in n8n settings.
  • Network Issues: Network failures or unreachable API endpoints result in network error messages.
  • API Error Responses: The node surfaces API error messages when the OnOffice API returns an error status. Review the message for details.

To resolve errors:

  • Validate all input parameters carefully.
  • Confirm API credentials are correct and active.
  • Check network connectivity.
  • Review API limits or restrictions imposed by OnOffice.

Links and References

Discussion