OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically focusing on relations between estates and addresses (contacts). The "Get" operation for the "Relation" resource 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 a contact, such as owner, tenant, or interested party.

Common scenarios:

  • Fetching the details of a particular relation to display or process in workflows.
  • Integrating OnOffice relation data into CRM or property management systems.
  • Automating updates or notifications based on relation information.

Example:
You have a workflow that triggers when a new relation is created or updated in OnOffice. Using this node's "Get Relation" operation, you retrieve the full details of that relation to enrich your database or send customized emails.

Properties

Name Meaning
Relation ID The unique identifier of the relation to retrieve or delete.
Fields Comma-separated list of fields to return from the relation record. Default: id,type,estateid,addressid

Output

The node outputs JSON data containing the requested relation information. The structure includes:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource involved, here always "relation".
  • operation: The operation performed, here "get".
  • data: An array of relation records matching the query, each containing the requested fields (e.g., id, type, estateid, addressid).
  • total (optional): Total number of records returned (mainly relevant for "getMany" operations).

No binary data output is produced by this operation.

Example output JSON snippet:

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

Dependencies

  • Requires valid credentials for the OnOffice API, including an API token and secret.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials within n8n is necessary for authentication.

Troubleshooting

  • Invalid JSON in Fields or Filter: If the "Fields" or any filter JSON is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message, e.g., "OnOffice API error: [message]". Check API credentials and request parameters.
  • Network Issues: Network errors will be reported with messages like "Network error: [details]". Verify network connectivity and API endpoint accessibility.
  • Missing Required Parameters: The "Relation ID" is required for the "Get" operation; omitting it will cause an error.
  • Unsupported Resource or Operation: Attempting unsupported combinations will result in clear error messages specifying the unsupported resource or operation.

Links and References

Discussion