Imobzi icon

Imobzi

Interagir com a API da Imobzi

Overview

This node interacts with the Imobzi API to retrieve multiple Lead records based on specified filters, ordering, limits, and offsets. It is useful for scenarios where you need to fetch a list of leads matching certain criteria from your Imobzi account, such as filtering leads by name, status, or other fields, sorting them, and paginating results.

Practical examples include:

  • Retrieving all leads that start with a specific name prefix.
  • Getting leads created after a certain date.
  • Fetching a limited number of leads ordered by creation date for reporting or further processing.

Properties

Name Meaning
Filtros A collection of filter conditions to apply when retrieving leads. Each condition includes:
- Campo Name or ID: The lead 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 lead records to return. Minimum value is 1. Default is 50.
Offset Number of lead records to skip before starting to collect the result set. Minimum value is 0. Default is 0.

Output

The output is an array of JSON objects representing the retrieved leads. Each object corresponds to one lead record returned by the Imobzi API. The structure of each lead object matches the fields available in the Imobzi leads resource, which can vary but typically includes identifiers, names, contact information, statuses, and other lead-related data.

No binary data is output by this operation.

Example output snippet:

[
  {
    "id": 123,
    "name": "Lead Name",
    "email": "lead@example.com",
    "phone": "123456789",
    ...
  },
  ...
]

Dependencies

  • Requires an active connection to the Imobzi API via an API key credential configured in n8n.
  • The node uses authenticated HTTP requests to the Imobzi API endpoints.
  • No additional external dependencies are required beyond the configured API authentication.

Troubleshooting

  • Unsupported Resource Error: If you select a resource not supported by the node, it will throw an error indicating the resource is unsupported. Ensure "Lead" is selected as the resource.
  • Unsupported Operation Error: Selecting an operation other than those implemented (create, get, getAll, update, delete) will cause an error. Use only supported operations.
  • API Authentication Errors: If the API key or credentials are invalid or missing, requests will fail. Verify the API key credential configuration.
  • Filter Misconfiguration: Filters must have valid field names, operators, and values. Invalid or empty filters may cause unexpected results or errors.
  • Rate Limits or Network Issues: API request failures due to rate limiting or connectivity issues will cause errors. Implement retry logic or check network status if needed.
  • Limit and Offset Values: Setting limit below 1 or offset below 0 is invalid and may cause errors. Use valid numeric values.

Links and References

Discussion