Nuvem Solution icon

Nuvem Solution

Interact with Nuvem Solution API

Actions120

Cliente → Get All

AI-generated

Overview

The "Cliente" resource with the "Get All" operation in this node allows users to retrieve a paginated list of customers from the Nuvem Solution API. It supports filtering by date ranges and CPF/CNPJ identifiers, enabling refined queries on customer data.

This node is beneficial in scenarios where you need to:

  • Synchronize or analyze customer data from the Nuvem Solution system.
  • Build reports or dashboards that require customer lists filtered by registration dates or identification numbers.
  • Automate workflows that depend on customer information retrieval with pagination support.

Example use case:
Fetch all customers registered between two dates, 50 per page, to process them in batches for marketing campaigns or data migration.

Properties

Name Meaning
Page Page number for pagination (which page of results to retrieve).
Page Size Number of items per page (how many customers to return per request).
CPF/CNPJ Filter customers by their CPF or CNPJ identifier (Brazilian individual/company tax IDs).
Start At Start date filter to retrieve customers created or updated after this date/time.
End At End date filter to retrieve customers created or updated before this date/time.

Output

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

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the Nuvem Solution API.
  • The node uses the base URL and authentication tokens obtained via these credentials.
  • Pagination and filtering parameters are passed as query parameters to the API.

Troubleshooting

  • Authentication errors: If the node fails due to authentication, verify that the API key credential is correctly configured and has valid permissions.
  • Invalid parameter values: Ensure that date filters (Start At, End At) are in proper ISO 8601 format and that Page and Page Size are positive integers.
  • Empty results: If no customers are returned, check if the filters are too restrictive or if the account has no matching customers.
  • API rate limits or connectivity issues: Network problems or API throttling may cause failures; retry or check API status.

Links and References

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

Discussion