Imobzi icon

Imobzi

Interagir com a API da Imobzi
Join our community

Actions62

Overview

This node interacts with the Imobzi API to retrieve multiple contract records ("Contrato" resource) based on user-defined filters, ordering, limits, and offsets. It is useful for scenarios where you need to fetch a list of contracts matching specific criteria from Imobzi, such as retrieving all active contracts starting with a certain client name or filtering contracts by date ranges.

Practical examples include:

  • Fetching all contracts that contain a specific keyword in a field.
  • Retrieving contracts ordered by creation date.
  • Paginating through contracts using limit and offset parameters.

Properties

Name Meaning
Filtros A collection of filter conditions to narrow down the contracts returned. Each filter includes:
- Campo Name or ID: The contract field to filter by (selectable from available contract fields).
- Operador: Comparison operator, options are: "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 contract records to return. Minimum value is 1. Default is 50.
Offset Number of contract records to skip before starting to collect the result set. Useful for pagination. Minimum value is 0. Default is 0.

Output

The output is an array of JSON objects representing the contracts retrieved from the Imobzi API. Each item corresponds to one contract record with its fields as returned by the API.

Example structure of each output item (fields depend on Imobzi's contract data schema):

{
  "id": "123",
  "client": "Client Name",
  "startDate": "2023-01-01",
  "endDate": "2023-12-31",
  "status": "active",
  ...
}

No binary data is output by this node.

Dependencies

  • Requires an API key credential configured in n8n to authenticate requests to the Imobzi API.
  • The node uses the Imobzi REST API endpoints corresponding to contracts (/contracts).
  • Network access to the Imobzi API service is required.

Troubleshooting

  • Error: Resource "contrato" not supported!
    This indicates an invalid resource parameter. Ensure the resource is correctly set to "contrato".

  • Error: Operation "getAll" not supported!
    Indicates an unsupported operation was selected. 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 necessary permissions.

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

  • Invalid Filter Fields or Operators
    Filters must use valid contract fields and supported operators. Use the provided dropdowns to avoid invalid inputs.

Links and References

Discussion