Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage customer data. Specifically, the "Customer - Get" operation retrieves detailed information about a single customer by their unique ID. This is useful in scenarios where you need to fetch up-to-date customer details for further processing, reporting, or integration with other systems.

For example, you might use this node to:

  • Retrieve a customer's profile before updating their records.
  • Fetch customer details to display in a dashboard.
  • Use customer data as input for automated workflows like sending personalized emails or generating invoices.

Properties

Name Meaning
Customer ID The unique identifier of the customer to retrieve. This is a required string input.

Output

The output is a JSON object representing the customer data returned from the Perfex API. It contains all available fields related to the specified customer, such as company name, VAT number, contact details, and any other customer-specific information stored in Perfex.

If multiple customers were returned (not applicable here since this is a single get operation), the output would be an array of such objects. No binary data output is produced by this operation.

Example output structure (simplified):

{
  "id": "123",
  "company": "Example Company",
  "vat": "VAT123456",
  "address": "...",
  "email": "...",
  // other customer fields
}

Dependencies

  • Requires an active connection to the Perfex API via an API key credential configured in n8n.
  • The base URL for the API must be set in the node credentials.
  • The node uses HTTP GET requests to fetch customer data from the endpoint /api/customers/{customerId}.

Troubleshooting

  • Invalid Customer ID: If the provided Customer ID does not exist or is malformed, the API will likely return a 404 error. Verify the ID is correct.
  • Authentication Errors: Missing or invalid API credentials will cause authentication failures. Ensure the API key and base URL are correctly configured.
  • Network Issues: Connectivity problems can cause request timeouts or failures. Check network access to the Perfex API server.
  • API Rate Limits: Excessive requests may trigger rate limiting. Implement retry logic or reduce request frequency if needed.
  • Error Handling: If the node is set to continue on failure, errors will be included in the output JSON with error messages and stack traces for debugging.

Links and References

Discussion