OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage "Relation" resources, specifically supporting the "Get Many" operation. It allows users to retrieve multiple relation records between estates and addresses (contacts) from the OnOffice system. This is useful in scenarios where you need to fetch lists of relations for reporting, synchronization, or further processing within an automation workflow.

For example, a real estate agency could use this node to pull all relations linking properties (estates) to contacts (owners, tenants, interested parties) to update their CRM or generate reports on property-contact relationships.

Properties

Name Meaning
Fields Comma-separated list of fields to return for each relation record (e.g., id,type,estateid,addressid). Specifies which data columns to include in the response.
Additional Fields Collection of optional parameters:
- Filter: JSON object defining criteria to filter the query results.
- Limit: Maximum number of results to return (default 50).
- Offset: Number of results to skip before starting to collect the result set (default 0).

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 "getMany".
  • data: An array of relation records matching the query, each containing the requested fields.
  • total (optional): Total count of matching records available (useful for pagination).
  • message (optional): Status message from the API.

Example output snippet:

{
  "success": true,
  "resourceType": "relation",
  "operation": "getMany",
  "data": [
    {
      "id": "123",
      "type": "owner",
      "estateid": "456",
      "addressid": "789"
    },
    ...
  ],
  "total": 150
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the OnOffice API.
  • The node uses HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • HMAC signature generation is used for request authentication, requiring both an API token and secret.
  • No additional external dependencies beyond the OnOffice API and n8n's built-in HTTP request helper.

Troubleshooting

  • Invalid JSON in Filter: If the "Filter" field contains invalid JSON, the node throws an error stating "Filter must be a valid JSON". Ensure the filter input is correctly formatted JSON.
  • API Authentication Errors: Errors related to invalid or missing API tokens/secrets will cause API errors. Verify that the API credentials are correctly configured.
  • Network Issues: Network connectivity problems will result in "Network error" messages. Check internet connection and API endpoint accessibility.
  • Unsupported Resource or Operation: If the resource or operation parameters are incorrect, the node throws errors indicating unsupported resource or operation.
  • Rate Limits or API Errors: The node surfaces API error messages returned by OnOffice. Review these messages for guidance on resolving issues such as rate limits or malformed requests.

Links and References

Discussion