Surense icon

Surense

Interact with Surense API

Lead → Search Leads

AI-generated

Overview

The node named "Surense" provides integration with the Surense API, allowing users to interact with various resources such as Leads, Contacts, Customers, and more. Specifically for the Lead resource and the Search Leads operation, this node enables searching for leads in the Surense system based on sorting, pagination, and quick filter criteria.

This node is beneficial when you want to automate lead retrieval from Surense within an n8n workflow, for example:

  • Fetching a sorted list of recent leads for follow-up.
  • Searching leads by name, email, or phone using a quick search term.
  • Paginating through large sets of leads to process them in batches.

Properties

Name Meaning
Order Sort order of the results: ascending (asc) or descending (desc).
Order By Field to sort the results by: creation date (createdDate) or last activity date (lastActivityDate).
Limit Maximum number of lead records to return per request (minimum 1).
Page Page number for paginated results (minimum 1).
Additional Parameters Collection of extra parameters; currently supports:
- Quick Filter A quick search string that can match lead name, ID, email, or phone number.

Output

The node outputs an array of JSON objects representing the leads retrieved from the Surense API according to the search criteria. Each item in the output corresponds to one lead record with its associated fields as returned by the API.

If the node supports binary data output (not explicitly shown in the provided code), it would typically represent files or attachments related to leads, but no binary output is indicated here.

Dependencies

  • Requires an active connection to the Surense API via an OAuth2 API credential configured in n8n.
  • The node depends on internal helper modules for operation execution and pagination handling.
  • No additional external dependencies are required beyond the Surense API access.

Troubleshooting

  • Common issues:
    • Invalid or expired API credentials will cause authentication failures.
    • Providing invalid values for pagination (e.g., page < 1) or limit may result in errors.
    • Using unsupported sort fields or orders could cause the API to reject the request.
  • Error messages:
    • Errors thrown during operation execution will be caught and can be output as error JSON if "Continue On Fail" is enabled.
    • Typical error messages might include authentication errors, invalid parameter errors, or network timeouts.
  • Resolution tips:
    • Verify API credentials and refresh tokens if necessary.
    • Ensure input parameters conform to expected types and ranges.
    • Use the quick filter carefully to avoid overly broad or malformed queries.

Links and References


Note: The summary is based solely on static analysis of the provided source code and property definitions.

Discussion