OnOffice

Consume OnOffice API
Join our community

Actions12

Overview

This node integrates with the OnOffice API to manage real estate-related data. Specifically, for the Estate - Get operation, it retrieves detailed information about a single estate record by its unique ID. This is useful when you need to fetch specific property details from your OnOffice account within an automated workflow.

Common scenarios:

  • Fetching detailed information about a particular estate to display or process further.
  • Integrating estate data retrieval into CRM or property management workflows.
  • Automating reporting or notifications based on estate attributes.

Example:
You want to retrieve the title and external number of a specific estate by its ID to update your internal database or trigger alerts if certain conditions are met.

Properties

Name Meaning
ID The unique identifier of the estate record to retrieve.
Fields Comma-separated list of fields to return from the estate record (e.g., Id,objekttitel,objektnr_extern).

Output

The output JSON contains the following structure:

  • success: Boolean indicating if the request was successful.
  • resourceType: The resource type, here always "estate".
  • operation: The operation performed, here "get".
  • data: An array of records returned by the API containing the requested estate fields.
  • total (optional): Total count of records if available.
  • message (optional): Status message from the API.

Example output JSON snippet:

{
  "success": true,
  "resourceType": "estate",
  "operation": "get",
  "data": [
    {
      "Id": "12345",
      "objekttitel": "Beautiful Family Home",
      "objektnr_extern": "EXT-6789"
    }
  ]
}

No binary data output is produced by this operation.

Dependencies

  • Requires an API authentication token and secret credential for the OnOffice API.
  • The node makes HTTP POST requests to the OnOffice API endpoint at https://api.onoffice.de/api/latest/api.php.
  • Proper configuration of the API credentials in n8n is necessary for authentication and HMAC signature generation.

Troubleshooting

  • Invalid JSON in Fields or Data:
    If the fields parameter or any JSON input is malformed, the node throws an error indicating invalid JSON. Ensure all JSON inputs are correctly formatted.

  • Missing or Incorrect ID:
    The ID property is required. Omitting it or providing an incorrect ID will cause the API to fail or return no data.

  • API Errors:
    Errors returned by the OnOffice API include messages from the API response. Common issues might be invalid credentials, insufficient permissions, or invalid parameters.

  • Network Issues:
    Network errors during the HTTP request will be reported. Check connectivity and API endpoint availability.

  • Unsupported Resource or Operation:
    The node validates resource and operation combinations. Using unsupported combinations results in clear error messages.

Links and References

Discussion