ADVBOX icon

ADVBOX

Consume Advbox API.

Actions17

Customer → Get Many

AI-generated

Overview

This node operation retrieves multiple customer records from the Advbox API based on various optional filter criteria. It is useful for scenarios where you need to fetch a list of customers matching specific attributes such as name, phone, identification, email, location, occupation, birthday month, creation date range, and supports pagination through limit and offset parameters. For example, you can use it to get all customers born in the current month or to search customers by partial name or city.

Use Case Examples

  1. Fetch customers with the name containing 'John' and limit the results to 50.
  2. Retrieve customers from a specific city and state with pagination support.
  3. Get customers who have birthdays in the current month.

Properties

Name Meaning
Name Customer name or part of it, allowing full or partial search terms.
Phone Customer phone number for filtering.
Identification Customer identification number (CPF/CNPJ) for filtering.
Document Customer document number for filtering.
Email Customer email address for filtering.
City Customer city for filtering.
State Customer state for filtering.
Occupation Customer occupation or profession for filtering.
Birthdays Boolean flag to filter customers by birthdays in the current month.
Created Start Start date for filtering customers by creation date (YYYY-MM-DD format).
Created End End date for filtering customers by creation date (YYYY-MM-DD format).
Limit Number of items to return in the response, between 1 and 1000.
Offset Number of items to skip before starting the response (pagination).

Output

JSON

  • json
    • ``
      * id - Unique identifier of the customer.
      * name - Name of the customer.
      * email - Email address of the customer.
      * phone - Phone number of the customer.
      * identification - Identification number (CPF/CNPJ) of the customer.
      * document - Document number of the customer.
      * city - City where the customer is located.
      * state - State where the customer is located.
      * occupation - Occupation or profession of the customer.
      * birthdate - Birthdate of the customer.
      * created_at - Creation date of the customer record.

Dependencies

  • Advbox API with API key credential

Troubleshooting

  • Common issues include authentication errors due to invalid or missing API credentials. Ensure the API key credential is correctly configured.
  • Invalid filter parameters may result in empty responses or errors. Verify that date formats and other filters conform to expected formats.
  • API rate limits or network issues may cause request failures. Check network connectivity and API usage limits.
  • Error messages from the API are propagated; review the error details for troubleshooting.

Links

  • Advbox API Documentation - Official API documentation for Advbox, useful for understanding available endpoints and parameters.

Discussion