OnOffice icon

OnOffice

Consume OnOffice API

Actions30

Overview

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

Common scenarios where this node is beneficial include:

  • Fetching a list of tasks assigned or related to real estate management.
  • Automating workflows that require bulk retrieval of task data for reporting or synchronization.
  • Integrating OnOffice task data into other systems or dashboards.

For example, a user might use this node to pull all current tasks to display in a project management tool or to trigger follow-up actions based on task statuses.

Properties

Name Meaning
Include Debug Info Whether to include detailed debug information in the output. If enabled, the node returns raw API response data and request details instead of just the processed results.

Output

The node outputs JSON data structured as follows:

  • When Include Debug Info is disabled (default):

    {
  "success": true,
  "resourceType": "task",
  "operation": "getMany",
  "data": []
}
    • success: Indicates if the API call was successful.
    • resourceType: The resource queried, here always "task".
    • operation: The operation performed, here "getMany".
    • data: An array containing the retrieved task records (empty array shown as placeholder).

  • When Include Debug Info is enabled:

    {
  "debug": true,
  "rawResponse": { /* full API response object */ },
  "requestSent": { /* full request payload sent to API */ },
  "url": "https://api.onoffice.de/api/latest/api.php"
}

    This includes the raw API response, the exact request sent, and the URL used, useful for troubleshooting.

The node does not output binary data.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • Uses the OnOffice API endpoint:
    • For the Task resource, the stable API URL: https://api.onoffice.de/api/latest/api.php
  • No additional external dependencies beyond the OnOffice API and n8n's HTTP request helper.

Troubleshooting

  • Common issues:

    • Invalid or missing API credentials will cause authentication failures.
    • Network connectivity problems can prevent reaching the OnOffice API.
    • Request limits or incorrect parameters may result in API errors.

  • Error messages:

    • "OnOffice API error: <message>" indicates the API returned an error status. The message provides details, e.g., invalid ID or permission denied.
    • "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 n8n credentials.
    • Check network access and firewall settings.
    • Enable Include Debug Info to get detailed request and response data for diagnosing issues.
    • Confirm that the requested resource and operation parameters are valid and supported.

Links and References

Discussion