onOffice icon

onOffice

onOffice custom node for n8n

Actions58

Estate → Get Files

AI-generated

Overview

This node operation retrieves files associated with a specific estate in the onOffice system. It is useful for scenarios where users need to access documents or images related to a real estate property, such as property photos, floor plans, or legal documents. For example, a real estate agent could use this node to fetch all files linked to a particular estate to display them on a website or include them in a client report.

Use Case Examples

  1. Fetch all files for estate ID 123 to display property images on a website.
  2. Retrieve a specific document by file ID for estate ID 456 to review legal paperwork.

Properties

Name Meaning
Estate ID The unique identifier of the estate for which files are being retrieved.
Document Attribute Filter files by a specific document attribute, if needed.
File ID Specify a particular file ID to retrieve a single file instead of a list.
Include Image URL Select the size of the image URL to include in the response (small, medium, or original).
List Limit Limit the number of files returned in the list.
List Offset Offset for pagination to skip a number of files before starting to return results.
Show Is Published On Homepage Boolean flag to include information whether the file is published on the homepage.
Show Publication Status Boolean flag to include the publication status of the file.

Output

JSON

  • files - Array of file objects associated with the specified estate, including metadata and optionally image URLs and publication status based on input options.

Dependencies

  • Requires an API key credential for onOffice API authentication.

Troubleshooting

  • Ensure the Estate ID is valid and exists in the onOffice system to avoid errors or empty results.
  • If filtering by File ID or Document Attribute, verify these values are correct to get expected files.
  • Check API credentials and permissions if authentication errors occur.
  • Pagination parameters (List Limit and List Offset) should be set correctly to avoid missing or duplicated files in paged results.

Links

  • onOffice API Documentation - Official API documentation for onOffice, useful for understanding available endpoints and parameters.

Discussion