API Conta Azul

Overview

The node "API Conta Azul" enables making requests to the Conta Azul API, a financial and business management platform. Specifically, the operation Buscar pessoas por filtro ("getPersonsByFilter") allows users to search for people records filtered by a search term that can match document numbers, client names, or company names. This is useful in scenarios where you want to retrieve customer or supplier information based on partial or full text queries.

Practical examples include:

• Searching for clients or suppliers by name or document number to integrate with CRM or ERP workflows.
• Filtering contacts dynamically during automation processes to update or enrich data.
• Paginating through large contact lists to process or export data in batches.

Properties

Output

The output of this operation is a JSON array containing the list of people matching the search criteria. Each item in the array represents a person record retrieved from the Conta Azul API, including details such as name, document, and other relevant fields.

If the API supports it, the output may also include pagination metadata (e.g., total count, current page), but this depends on the underlying API response structure.

This node does not output binary data for this operation.

Dependencies

• Requires an OAuth2 API credential configured in n8n to authenticate requests to the Conta Azul API.
• The node depends on the external Conta Azul API service being available and accessible.
• Proper permissions/scopes must be granted to the API key/token to perform read operations on people data.

Troubleshooting

• Common issues:

  • Invalid or expired API credentials will cause authentication errors.
  • Providing an empty or invalid search term might return no results or an error.
  • Pagination parameters out of range may result in empty responses.
  • Network connectivity issues can prevent successful API calls.

• Error messages:

  • "Operação não suportada": This indicates an unsupported operation was requested; ensure the operation parameter is set correctly.
  • Authentication errors typically indicate problems with the OAuth2 token; re-authenticate or check credentials.
  • API rate limits or quota exceeded errors require waiting or adjusting usage.

• Resolutions:

  • Verify and refresh API credentials.
  • Use valid and meaningful search terms.
  • Adjust pagination parameters within allowed ranges.
  • Check network connectivity and API status.

Links and References

• Conta Azul API Documentation
• n8n OAuth2 Credential Setup
• Pagination Best Practices