Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Cliente → Get Clientes Paginacao

AI-generated

Overview

The "Get Clientes Paginacao" operation of the "Cliente" resource in this node allows users to retrieve a paginated list of customers from the Nuvem Solution API. This operation supports filtering customers by date ranges, enabling efficient querying of customer data in manageable chunks.

This node is beneficial when you need to:

  • Retrieve large sets of customer data without overwhelming the system or network.
  • Implement pagination in workflows that process or display customer lists.
  • Filter customers based on creation or update timestamps within specific date ranges.

Practical example:
A business wants to sync their CRM with Nuvem Solution and only fetch customers created or updated between two dates, retrieving 50 customers per page. Using this operation, they can iterate through pages to process all relevant customers efficiently.

Properties

Name Meaning
Page The page number to retrieve in the paginated results (e.g., 1 for the first page).
Page Size Number of customer items to return per page (e.g., 20).
Start At Optional start date/time filter to include customers from this date onwards.
End At Optional end date/time filter to include customers up to this date.

Output

The output is a JSON array containing customer objects as returned by the Nuvem Solution API endpoint /erp/crm/clientes/ListarClientesPaginacao. Each object represents a customer record with its associated fields (such as ID, name, contact info, etc.). The exact structure depends on the API response but typically includes customer details relevant for CRM or sales processes.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Nuvem Solution API.
  • The node expects valid credentials including software key, secret, user ID, and user key.
  • Network access to the configured base URL of the Nuvem Solution API is necessary.
  • Pagination parameters must be managed by the user to iterate through multiple pages if needed.

Troubleshooting

  • Authentication errors: If authentication fails, verify that the provided API credentials (software key, secret, user ID, user key) are correct and have sufficient permissions.
  • Invalid date filters: Ensure that Start At and End At are valid ISO 8601 date-time strings. Incorrect formats may cause API errors or empty results.
  • Pagination issues: Requesting a page number beyond the available range will likely return an empty result set. Adjust the page number accordingly.
  • API rate limits: Excessive requests in a short time may trigger rate limiting; implement delays or retries as needed.
  • Empty results: If no customers match the filters, the output will be an empty array. Confirm filter criteria and data availability.

Links and References

This summary is based solely on static analysis of the provided source code and property definitions.

Discussion