onOffice icon

onOffice

onOffice custom node for n8n

Estate → Read

AI-generated

Overview

This node reads data for a single Estate from the onOffice system. It allows users to specify the Estate ID and select which parameters to retrieve, such as address details, object type, marketing type, and more. Additional options include formatting the output, limiting the number of results, sorting, and adding a mobile URL. This node is useful for scenarios where detailed information about a specific real estate property is needed, such as in real estate management, property listings, or integration with other systems.

Use Case Examples

  1. Retrieve detailed information about a specific estate by providing its Estate ID and selecting relevant parameters like address, object type, and marketing type.
  2. Fetch a list of estates with pagination and sorting options to display in a real estate application.

Properties

Name Meaning
Estate ID The unique identifier of the Estate to read data for.
Parameters The specific fields or attributes of the Estate to retrieve, such as address, object type, or marketing type.
Additional Fields Additional options to customize the output, such as formatting, limit, offset, sorting order, and whether to add a mobile URL.

Output

JSON

  • estate
    • id - The unique identifier of the Estate.
    • address
      * street - Street address of the Estate.
      * houseNumber - House number of the Estate.
      * postalCode - Postal code of the Estate.
      * city - City or location of the Estate.
    • objectType - Type of the real estate object.
    • marketingType - Marketing type of the Estate.
    • parameters - Selected parameters and their values for the Estate.
    • mobileUrl - Mobile URL if added to the output.

Dependencies

  • An API key credential for onOffice API access

Troubleshooting

  • Ensure the Estate ID is correctly provided and exists in the onOffice system to avoid empty or error responses.
  • Check API credentials and permissions if authentication errors occur.
  • Verify that the selected parameters are valid and supported by the onOffice API for the Estate resource.

Discussion