ADVBOX icon

ADVBOX

Consume ADVBOX API

Actions8

Overview

This node integrates with the ADVBOX API to manage and retrieve legal-related data. Specifically, for the Customer - Get many operation, it fetches multiple customer records from the ADVBOX system based on optional filtering criteria. This is useful in scenarios where you need to list customers matching certain attributes or paginate through large customer datasets.

Practical examples include:

  • Retrieving a list of customers whose names contain a specific substring.
  • Fetching customers by phone number or identification number.
  • Paginating through customers with limit and offset parameters to handle large result sets efficiently.

Properties

Name Meaning
Name Customer name or part of it. You can use a full name or a partial search term (e.g., first or last name).
Phone Customer phone number (e.g., 4899123456 or (48)99123-4567).
Identification Customer identification number (CPF/CNPJ).
Limit Number of items to return in the response, between 1 and 1000.
Offset Number of items to skip before starting the response (used for pagination).

Output

The node outputs an array of JSON objects representing customer records retrieved from the ADVBOX API. Each object corresponds to a customer and contains fields as returned by the API, such as customer details including name, phone, identification, and other relevant metadata.

No binary data output is produced by this operation.

Dependencies

  • Requires an API key credential for authenticating with the ADVBOX API.
  • The node expects the ADVBOX API URL and token to be configured in the credentials.
  • Network access to the ADVBOX API endpoint is necessary.

Troubleshooting

  • Common issues:

    • Invalid or missing API token will cause authentication failures.
    • Providing invalid filter values (e.g., non-numeric limit or offset) may result in API errors.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Errors related to authentication typically indicate missing or incorrect API tokens; verify your credentials configuration.
    • Pagination errors may occur if limit or offset are out of allowed ranges; ensure these values are within specified bounds.
    • If the API returns unexpected errors, check the request parameters and network status.

Links and References

Discussion