Conta Azul API icon

Conta Azul API

Allows making requests to the Conta Azul API

Actions18

Search Persons By Filter

AI-generated

Overview

This node operation allows users to search for persons in the Conta Azul system using various filter criteria. It is useful for scenarios where you need to find customer or company information based on document numbers, names, or other attributes. For example, you can search for a person by their document ID or name and paginate through the results.

Use Case Examples

  1. Search for customers by their CPF or CNPJ document number.
  2. Find companies or individuals by name or partial name match.
  3. Retrieve a paginated list of persons matching specific search terms.

Properties

Name Meaning
Search Term Search by document, customer name, or company name.
Page Page number for paginated results.
Page Size Number of items to return per page.

Output

JSON

  • id - Unique identifier of the person.
  • name - Name of the person or company.
  • document - Document number such as CPF or CNPJ.
  • email - Email address of the person.
  • phone - Phone number of the person.
  • address - Address details of the person or company.

Dependencies

  • Conta Azul API OAuth2 credentials

Troubleshooting

  • Ensure the Conta Azul OAuth2 API credentials are correctly configured and valid.
  • Verify that the search term is correctly formatted and not empty to avoid empty results.
  • Check API rate limits and handle errors gracefully, especially when using pagination.

Links

Discussion