OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, the "Estate" resource with the "Get" operation allows users to retrieve detailed information about a single estate record by its ID. This is useful in scenarios where you need to fetch specific property details such as title, external number, or other metadata stored in OnOffice.

Practical examples include:

  • Fetching an estate's details to display on a website or dashboard.
  • Retrieving property information for further processing or integration with other systems.
  • Automating workflows that require up-to-date estate data from OnOffice.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve. This is required for the "Get" operation.
Fields Comma-separated list of fields to return from the estate record (e.g., Id,objekttitel,objektnr_extern). Allows customization of which estate attributes are fetched.

Output

The output JSON contains the following structure:

  • 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 estate records matching the query. For the "Get" operation, this will typically contain one object with the requested fields.
  • total (optional): Total count of records returned (mainly relevant for multi-record queries).
  • message (optional): Status message from the API response.
  • rawResponse (optional): The full raw response from the API for debugging or extended use.

No binary data output is produced by this operation.

Example output snippet:

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

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: https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of these credentials within n8n is necessary for successful execution.

Troubleshooting

  • Invalid JSON in Fields or Data: If the "Fields" or "Data" parameters contain invalid JSON or malformed input, the node throws an error. Ensure these inputs are correctly formatted.
  • API Authentication Errors: Missing or incorrect API credentials will cause authentication failures. Verify that the API token and secret are correctly set.
  • Record Not Found: If the provided ID does not exist, the API may return an error or empty data. Confirm the ID is valid.
  • Filter Parsing Errors: When using filters (not applicable for "Get" but for other operations), ensure JSON filters are valid; otherwise, errors occur.
  • Network Issues: Network connectivity problems result in network error messages. Check internet connection and API availability.

Links and References

Discussion