OnOffice

Consume OnOffice API

Actions12

Overview

This node interacts with the OnOffice API to manage real estate-related data, specifically handling resources such as estates, addresses, and relations. For the Relation resource with the Get operation, it retrieves detailed information about a specific relation by its ID. This is useful when you want to fetch the connection details between an estate and an address (contact), such as ownership or tenancy relationships.

Practical examples include:

  • Fetching the owner or tenant information linked to a particular estate.
  • Retrieving contact details associated with a property for further processing or notifications.
  • Integrating OnOffice relation data into workflows that require up-to-date relationship info between properties and contacts.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve. This specifies which relation record to fetch.
Fields Comma-separated list of fields to return from the relation record. Default is id,type,estateid,addressid. You can specify any combination of available relation fields to customize the output.

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "get".
  • data: An array of relation records matching the request. For the Get operation, this typically contains one relation object with the requested fields.
  • total (optional): Total number of records returned (mainly relevant for multi-record queries).

Example output JSON snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "get",
  "data": [
    {
      "id": "12345",
      "type": "owner",
      "estateid": "67890",
      "addressid": "54321"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires valid credentials for the OnOffice API, including an API token and secret.
  • The node uses HMAC signature authentication for secure API requests.
  • Network access to https://api.onoffice.de/api/v1 is necessary.
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Invalid Relation ID: If the provided Relation ID does not exist or is malformed, the API will return an error. Ensure the ID is correct and exists in OnOffice.
  • Invalid Fields Format: The Fields parameter must be a comma-separated string of valid field names. Incorrect formatting or invalid field names may cause errors or incomplete data.
  • API Authentication Errors: Missing or incorrect API credentials will result in authentication failures. Verify that the API token and secret are correctly configured in n8n credentials.
  • Network Issues: Connectivity problems to the OnOffice API endpoint will cause network errors. Check your internet connection and firewall settings.
  • JSON Parsing Errors: Although not directly applicable to the Get operation, other operations expect valid JSON input. Invalid JSON in those cases triggers errors.

Common error messages:

  • "OnOffice API error: <message>" indicates an issue reported by the API, often due to invalid parameters or permissions.
  • "Network error: <message>" indicates connectivity issues.
  • "Filter must be a valid JSON" appears if a filter parameter is malformed (not relevant for simple Get but for Get Many).

Links and References

Discussion