Actions29
- Cliente Actions
- Antecipação Actions
- Assinatura Actions
- Cobrança Actions
- Link De Pagamento Actions
- Webhook Actions
Overview
This node integrates with the Asaas API to manage customers and their related data. Specifically, for the "Cliente" (Customer) resource with the "Get Many" operation, it retrieves multiple customer records from Asaas, optionally filtered by name or CPF/CNPJ (Brazilian individual/company tax identifiers), and limited by a maximum number of results.
Common scenarios where this node is beneficial include:
- Fetching a list of customers for reporting or synchronization with other systems.
- Filtering customers by name or tax ID to find specific clients.
- Automating workflows that require bulk access to customer data from Asaas.
Practical example:
- A business wants to retrieve up to 50 customers whose names contain "Silva" to send them a promotional email campaign.
- Another use case is fetching all customers with a specific CPF/CNPJ to verify their payment status.
Properties
| Name | Meaning |
|---|---|
| Limite | Maximum number of customer results to return (minimum 1). Default is 50. |
| Nome (Filtro) | Filter customers by their name. Only customers whose names match this string are returned. |
| CPF/CNPJ (Filtro) | Filter customers by their CPF or CNPJ number. Only customers matching this identifier are returned. |
Output
The output is an array of JSON objects representing customer records retrieved from the Asaas API. Each item in the output corresponds to one customer and contains all the fields provided by the API for that customer.
Example structure of each JSON object (fields may vary depending on API response):
{
"id": "cus_000000000000",
"name": "Customer Name",
"cpfCnpj": "12345678901",
"email": "customer@example.com",
"mobilePhone": "5511999999999",
"phone": "551133333333",
"postalCode": "01234567",
"addressNumber": "123",
"addressComplement": "Apt 45",
...
}
No binary data output is produced by this operation.
Dependencies
- Requires an active connection to the Asaas API via an API key credential.
- The node uses the Asaas API base URL, which switches between sandbox and production environments based on credential configuration.
- No additional external services are required beyond the Asaas API.
Troubleshooting
- Package Removed Error: If the node throws an error indicating the package was removed from npm, it means the underlying integration package is no longer available. The recommended action is to remove this node from your workflow and update to a supported version or alternative.
- Invalid Customer ID: When filtering or retrieving customers, ensure that IDs and filter values are valid and correctly formatted.
- API Authentication Errors: Verify that the API key credential is correctly configured and has the necessary permissions.
- Rate Limits or Timeouts: Large requests or network issues might cause timeouts; consider reducing the limit or adding retries.
- Empty Results: If filters are too restrictive or incorrect, the node may return no customers.