OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate data. Specifically, for the Estate resource and the Get Many operation, it retrieves multiple estate records from the OnOffice system based on specified criteria.

Common scenarios where this node is beneficial include:

  • Fetching a list of estates for display in dashboards or reports.
  • Retrieving filtered estate data for further processing or integration with other systems.
  • Paginating through large sets of estate records by using limit and offset parameters.

Practical example:

  • A real estate agency wants to pull all available estates with specific fields like ID, title, and external number, applying filters such as location or price range, and limiting results to 50 per request.

Properties

Name Meaning
Fields Comma-separated list of estate fields to return (e.g., Id,objekttitel,objektnr_extern).
Additional Fields Collection of optional parameters:
- Filter JSON object defining filter criteria to narrow down the query results.
- Limit Maximum number of estate records to return (default 50).
- Offset Number of records to skip before starting to collect the result set (default 0).

Output

The output is a JSON array where each item contains:

  • success: Boolean indicating if the API call was successful.
  • resourceType: The resource involved, here always "estate".
  • operation: The operation performed, here "getMany".
  • data: An array of estate records matching the query, each containing the requested fields.
  • total (optional): Total count of matching records available in the backend (if provided by the API).

Example output snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "getMany",
  "data": [
    {
      "Id": "123",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT456"
    },
    ...
  ],
  "total": 150
}

No binary data is produced by this operation.

Dependencies

  • Requires an API token and secret for authenticating with the OnOffice API.
  • The node uses HMAC signatures for request authentication.
  • The base URL for API requests is https://api.onoffice.de/api/latest/api.php.
  • Proper credentials must be configured in n8n to allow access to the OnOffice API.

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: If the API token or secret is incorrect or missing, the node will fail with an authentication error. Verify that the API credentials are correctly set up.
  • Network Issues: Network errors during the HTTP request will cause the node to throw a network error message. Check internet connectivity and API endpoint availability.
  • Unsupported Resource or Operation: If the resource or operation is not supported, the node throws an error indicating the unsupported action.
  • Limit and Offset Usage: Setting very high limits or offsets may lead to performance issues or empty results if out of range.

Links and References

Discussion