Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage contacts, leads, and customers. Specifically for the Contact - Get operation, it retrieves detailed information about a single contact by its unique ID. This is useful in scenarios where you need to fetch up-to-date contact details from your CRM system within an automated workflow.

Practical examples include:

  • Automatically retrieving contact details when processing incoming support tickets.
  • Fetching contact information to personalize email campaigns.
  • Synchronizing contact data between Perfex and other systems.

Properties

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

Output

The node outputs the retrieved contact data as JSON. The structure corresponds directly to the contact object returned by the Perfex API's GET /api/contacts/{contactId} endpoint. It typically includes fields such as first name, last name, email, phone numbers, address, and any custom fields defined in the Perfex system.

If multiple contacts were returned (not applicable for this single get operation), each would be output as a separate JSON item. No binary data is produced by this operation.

Dependencies

  • Requires an active connection to the Perfex API via an API key credential configured in n8n.
  • The base URL of the Perfex instance must be set in the node credentials.
  • The node uses standard HTTP methods (GET) to interact with the Perfex REST API.

Troubleshooting

  • Common issues:

    • Invalid or missing Contact ID will cause the API request to fail.
    • Incorrect or expired API credentials will result in authentication errors.
    • Network connectivity problems can prevent reaching the Perfex API.

  • Error messages:

    • Errors from the API are caught and returned as part of the node output if "Continue On Fail" is enabled.
    • Typical error messages include "Not Found" if the contact ID does not exist, or "Unauthorized" if credentials are invalid.

  • Resolutions:

    • Verify the Contact ID is correct and exists in the Perfex system.
    • Ensure API credentials are valid and have sufficient permissions.
    • Check network access and Perfex server availability.

Links and References

Discussion