Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage customer data. Specifically, the "Customer - Get Many" operation retrieves multiple customer records from the Perfex system. It supports filtering customers by company name, email, or phone number, and allows controlling how many results to return.

Common scenarios include:

  • Fetching a list of customers for reporting or synchronization with other systems.
  • Filtering customers based on specific criteria like company name or contact details.
  • Retrieving all customers or limiting the number of returned entries for pagination.

Practical example:

  • A user wants to get all customers whose company name contains "Acme" and limit the results to 50 entries to display in a dashboard.

Properties

Name Meaning
Company Filter Filter customers by their company name (string).
Email Filter Filter customers by their email address (string).
Phone Filter Filter customers by their phone number (string).

Note: The node also supports standard parameters like returnAll (boolean) to fetch all records or limit the number of results, and limit (number) to specify the maximum number of customers to retrieve when not returning all.

Output

The output is an array of JSON objects, each representing a customer record retrieved from the Perfex API. Each object contains the customer's data fields as returned by the API.

If multiple customers are returned, each is output as a separate item in the node's output array.

No binary data output is produced by this operation.

Dependencies

  • Requires an active connection to the Perfex API via an API key credential configured in n8n.
  • The node uses the base URL provided in the credentials to make HTTP requests.
  • No additional external dependencies beyond the Perfex API and n8n's HTTP request helper.

Troubleshooting

  • Empty results: If filters are too restrictive or incorrect, no customers may be returned. Verify filter values.
  • API errors: Common errors include authentication failures (invalid API key), rate limits, or network issues. Ensure the API key is valid and the base URL is correct.
  • Limit parameter ignored: Make sure returnAll is set to false to apply the limit parameter.
  • Unexpected response structure: If the API changes, the node might fail to parse responses correctly. Check for updates or API changes.

Links and References

Discussion