OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Relation → Get Many

AI-generated

Overview

This node integrates with the OnOffice API to perform various operations on different resources such as estates, addresses, relations, agent logs, tasks, and IDs from relations. Specifically, for the Relation resource with the Get Many operation, it retrieves multiple relation records from the OnOffice system.

Common scenarios where this node is beneficial include:

  • Fetching a list of relations (e.g., clients, contacts) managed in OnOffice for further processing or reporting.
  • Integrating OnOffice relation data into workflows that require bulk access to contact information.
  • Automating synchronization of relation data between OnOffice and other systems.

Example use case: A real estate agency wants to pull all client relations from OnOffice to update their CRM or send marketing emails.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information in the output. If enabled, the node returns raw API response and request details for troubleshooting purposes.

Output

The node outputs JSON data structured as follows when successful:

  • success: Boolean indicating if the API call was successful (true).
  • resourceType: The resource involved, here "relation".
  • operation: The operation performed, here "getMany".
  • data: An array containing the retrieved relation records from OnOffice.

If "Include Debug Info" is enabled, the output includes additional fields:

  • debug: Set to true.
  • rawResponse: The full raw response object returned by the OnOffice API.
  • requestSent: The exact request payload sent to the API.
  • url: The API endpoint URL used.

In case of failure (and if the node is configured to continue on fail), the output contains:

  • success: false
  • error: Error message describing what went wrong.
  • resourceType and operation for context.

The node does not output binary data.

Dependencies

  • Requires an API authentication token and secret credential for OnOffice API access.
  • Uses the OnOffice API endpoints:
    • Stable API URL for Relation Get Many: https://api.onoffice.de/api/stable/api.php
    • Latest API URL for other cases: https://api.onoffice.de/api/latest/api.php
  • Relies on HMAC signature generation for secure API requests.
  • Requires n8n HTTP Request helper for making POST requests.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Incorrect resource or operation parameters may lead to unexpected errors or empty results.
    • Network connectivity problems can prevent reaching the OnOffice API endpoint.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API responded with an error status. Check the message for details.
    • "Unknown error" means the API response did not contain a clear error message.

  • Resolutions:

    • Verify that the API token and secret are correctly configured in the node credentials.
    • Ensure the resource is set to "relation" and operation to "getMany" for this specific use case.
    • Enable "Include Debug Info" to get detailed request and response data for debugging.
    • Check network settings and firewall rules to allow outbound HTTPS requests to api.onoffice.de.

Links and References

Discussion