Imobzi icon

Imobzi

Interagir com a API da Imobzi

Overview

This node interacts with the Imobzi API to manage various resources, including accounts. Specifically, the "Get Many" operation for the Account resource retrieves multiple account records from Imobzi. It supports filtering, ordering, pagination (limit and offset), allowing users to fetch a customized list of accounts.

Common scenarios where this node is beneficial include:

  • Retrieving a list of accounts for reporting or synchronization purposes.
  • Fetching accounts with specific criteria using filters.
  • Paginating through large sets of accounts in batches.
  • Ordering accounts by a particular field to organize results.

For example, you could use this node to get the first 50 accounts ordered by creation date or to retrieve accounts starting from a certain offset for batch processing.

Properties

Name Meaning
Order By Field name by which to order the returned accounts.
Limit Maximum number of account results to return (minimum 1, default 50).
Offset Number of account items to skip before starting to collect the result set (minimum 0).

These properties allow control over how many accounts are retrieved, where to start in the list, and how the results are sorted.

Output

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

  • The json property contains the account data object(s).
  • No binary data output is produced by this operation.

Example output snippet (simplified):

[
  {
    "id": 123,
    "name": "Account Name",
    "email": "account@example.com",
    ...
  },
  {
    "id": 124,
    "name": "Another Account",
    "email": "another@example.com",
    ...
  }
]

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 the "account" resource.
  • Network connectivity to the Imobzi service is necessary.

Troubleshooting

  • Unsupported Resource Error: If the resource parameter is not "account" or another supported resource, the node throws an error indicating the resource is unsupported.
  • Unsupported Operation Error: If an operation other than "getAll" (Get Many) is selected without proper support, an error will be thrown.
  • API Authentication Errors: Ensure that the API key credential is correctly configured and valid; otherwise, authentication failures will occur.
  • Invalid Parameter Values: Providing invalid values for limit (less than 1) or offset (negative) may cause errors or unexpected behavior.
  • Empty Results: If no accounts match the filters or if offset exceeds available data, the output may be empty.

To resolve errors:

  • Verify credentials and API access.
  • Check parameter values for correctness.
  • Confirm the resource and operation selections are supported.

Links and References

Discussion