OnOffice

Consume OnOffice API

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data, specifically estates, addresses, and relations. For the Address resource with the Get operation, it retrieves detailed information about a single address record by its ID. This is useful when you need to fetch contact details or other address-specific data stored in OnOffice.

Practical examples include:

  • Retrieving a client's contact information by their unique address ID.
  • Fetching address details to populate forms or CRM systems.
  • Integrating address data into workflows for notifications or reporting.

Properties

Name Meaning
ID The unique identifier of the address record to retrieve.
Fields Comma-separated list of fields to return from the address record (e.g., id, name, vorname, email).

Output

The node outputs JSON data structured as follows:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource type, here always "address".
  • operation: The operation performed, here "get".
  • data: Contains the retrieved address records returned by the API under data.records.
  • total (optional): Total number of records if available in metadata.
  • message (optional): Status message from the API response.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "address",
  "operation": "get",
  "data": [
    {
      "id": "123",
      "name": "Doe",
      "vorname": "John",
      "email": "[email protected]"
      // other requested fields...
    }
  ],
  "total": 1
}

The node does not output binary data.

Dependencies

  • Requires an active connection to the OnOffice API using valid API credentials (an API token and secret).
  • The node expects these credentials to be configured in n8n prior to execution.
  • Network access to https://api.onoffice.de/api/latest/api.php is required.

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.
  • Missing or Invalid ID: The ID property is required for the Get operation. Omitting it or providing an incorrect ID will cause the API to fail.
  • API Errors: If the OnOffice API returns an error, the node surfaces the message. Common issues include authentication failures (check API credentials) or requesting non-existent records.
  • Network Issues: Network errors during the HTTP request will be reported. Verify internet connectivity and API endpoint accessibility.
  • Unsupported Resource or Operation: The node validates resource-operation combinations; unsupported ones will throw descriptive errors.

To resolve errors:

  • Double-check input parameters, especially IDs and JSON fields.
  • Confirm API credentials are correct and have necessary permissions.
  • Review API limits or restrictions on the OnOffice side.

Links and References

Discussion