Imobzi icon

Imobzi

Interagir com a API da Imobzi

Overview

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

For example, you can use this node to:

  • Retrieve all events starting with a certain title.
  • Get events that contain a keyword in their description.
  • Fetch a limited number of upcoming events ordered by date.
  • Skip a number of events to paginate through results.

Properties

Name Meaning
Filtros A collection of filter conditions to narrow down the events returned. Each filter includes:
- Campo Name or ID: The event 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 event records to return. Minimum is 1. Default is 50.
Offset Number of event records to skip before starting to return results. Useful for pagination. Minimum is 0.

Output

The output is an array of JSON objects representing the retrieved events. Each object corresponds to one event record as returned by the Imobzi API. The structure of each event object depends on the Imobzi API's event schema but typically includes fields like title, date, description, and other event-specific data.

No binary data is output by this operation.

Example output snippet (simplified):

[
  {
    "title": "Open House",
    "date": "2024-07-01T10:00:00Z",
    "description": "An open house event for prospective buyers.",
    "id": 12345
  },
  {
    "title": "Maintenance Schedule",
    "date": "2024-07-05T08:00:00Z",
    "description": "Scheduled maintenance for property #6789.",
    "id": 12346
  }
]

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

  • Common Issues:

    • Incorrect or missing API credentials will cause authentication failures.
    • Using unsupported resource or operation names will throw errors.
    • Providing invalid filter fields or operators may result in empty responses or API errors.
    • Exceeding API rate limits could cause request failures.
  • Error Messages:

    • "Recurso \"evento\" não suportado!" — Means the resource "evento" is not supported; ensure the resource parameter is correctly set.
    • "Operação \"getAll\" não suportada!" — Means the operation "getAll" is not supported; verify the operation parameter.
    • Network or authentication errors will be reported by the underlying HTTP request helper; check API credentials and network connectivity.
  • Resolution Tips:

    • Verify API credentials and permissions.
    • Double-check filter field names and operators.
    • Use smaller limits or add offsets to paginate large datasets.
    • Enable "Continue On Fail" in the node settings to handle partial failures gracefully.

Links and References

Discussion