Perfex

Consume Perfex API
Join our community

Actions14

Overview

This node integrates with the Perfex API to manage "Lead" resources, specifically supporting the retrieval of multiple leads. It allows users to fetch either all leads or a limited number based on their needs. This is useful in scenarios such as syncing lead data from Perfex into other systems, generating reports, or performing bulk operations on lead data.

For example, a marketing automation workflow might use this node to pull all leads for segmentation, or a sales dashboard could retrieve a subset of recent leads for display.

Properties

Name Meaning
Return All Whether to return all lead records or only up to a specified limit.
Limit The maximum number of lead records to return when "Return All" is set to false (1-100).

Output

The node outputs an array of JSON objects, each representing a lead retrieved from the Perfex API. Each object contains the lead's data fields as returned by the API.

No binary data output is produced by this operation.

Dependencies

  • Requires connection to the Perfex API via an API key credential.
  • The base URL for the API must be configured in the node credentials.
  • The node uses standard HTTP methods (GET) to interact with the /api/leads endpoint.

Troubleshooting

  • Common issues:

    • Incorrect or missing API base URL or authentication credentials will cause request failures.
    • Requesting more than 100 leads when "Return All" is false will result in an error due to the enforced limit.
    • Network connectivity problems can prevent successful API calls.

  • Error messages:

    • Authentication errors typically indicate invalid or missing API keys; verify credentials.
    • Rate limiting or permission errors come from the API and require checking API usage policies or user permissions.
    • If the node throws an error about invalid parameters, ensure that "Limit" is within the allowed range (1-100).

Links and References

Discussion