Imobzi icon

Imobzi

Interagir com a API da Imobzi
Join our community

Actions62

Overview

This node interacts with the Imobzi API to retrieve multiple "Documento" (Document) records based on specified filters, ordering, limits, and offsets. It is useful for scenarios where you need to fetch a list of documents from Imobzi, such as generating reports, syncing document data, or filtering documents by specific criteria.

For example, you can use this node to:

  • Retrieve all documents that contain a certain keyword in their filename.
  • Fetch documents created after a specific date.
  • Get a paginated list of documents ordered by creation date.

Properties

Name Meaning
Filtros A collection of filter conditions to narrow down the documents returned. Each filter includes:
- Campo Name or ID: The document field to filter by (loaded dynamically).
- Operador: Comparison operator:
- Começa Com (starts_with)
- Contém (contains)
- Diferente (neq)
- Igual (eq)
- Maior Ou Igual (gte)
- Maior Que (gt)
- Menor Ou Igual (lte)
- Menor Que (lt)
- Não Contém (not_contains)
- Termina Com (ends_with)
- Valor: The value to compare against.
Order By Field name to order the results by.
Limit Maximum number of document records to return. Minimum value is 1. Default is 50.
Offset Number of document records to skip before starting to collect the result set. Useful for pagination. Minimum value is 0.

Output

The output is an array of JSON objects representing the documents retrieved from the Imobzi API. Each object contains the fields of a document as returned by the API, such as filename, ID, and other metadata.

Example output structure (simplified):

[
  {
    "id": 123,
    "filename": "contract.pdf",
    "created_at": "2023-01-01T12:00:00Z",
    "description": "Contract document"
    // ... other document fields
  },
  {
    "id": 124,
    "filename": "invoice.pdf",
    "created_at": "2023-02-01T12:00:00Z",
    "description": "Invoice document"
    // ... other document fields
  }
]

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Imobzi API.
  • The node uses the Imobzi REST API endpoints under /documents for this operation.
  • No additional external dependencies are required.

Troubleshooting

  • Error: Resource "documento" not supported!
    This indicates an internal mapping issue or misconfiguration. Ensure the resource is correctly set to "documento".

  • Error: Operation "getAll" not supported!
    This suggests the operation parameter is incorrect or unsupported. Confirm the operation is set to "Get Many" / "getAll".

  • API Authentication Errors
    If authentication fails, verify that the API key credential is correctly configured and has sufficient permissions.

  • Empty Results
    If no documents are returned, check your filter conditions and ensure they match existing document data.

  • Invalid Filter Fields or Operators
    Using a field or operator not supported by the API may cause errors or empty results. Use the dynamic options provided to select valid fields.

Links and References

Discussion