Actions36
- Activity Actions
- Contact Actions
- Customer Actions
- Data Proxy Actions
- Document Actions
- Employer Actions
- Lead Actions
- Meeting Actions
- Meeting Summary Actions
- Report Actions
- Workflow Actions
Contact → Search Contacts
AI-generatedOverview
The node interacts with the Surense API to perform various operations on different resources. Specifically, for the Contact resource and the Search Contacts operation, it allows users to search for contacts within the Surense system based on sorting, pagination, and quick filter criteria. This is useful in scenarios where you need to retrieve a filtered list of contacts, such as generating contact lists for marketing campaigns, customer support follow-ups, or data synchronization tasks.
Practical examples:
- Retrieve the most recently created contacts sorted in descending order.
- Search contacts by name, email, or phone using a quick filter term.
- Paginate through large sets of contacts 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 update date (lastActivityDate). |
| Limit | Maximum number of results 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 term that can match name, ID, email, or phone to filter contacts quickly. |
Output
The output is an array of JSON objects representing the contacts matching the search criteria. Each item corresponds to a contact record returned from the Surense API. The exact structure of each contact object depends on the API response but typically includes fields like contact identifiers, names, emails, phone numbers, creation dates, and other relevant metadata.
No binary data output is indicated for this operation.
Dependencies
- Requires an API key credential for authenticating with the Surense API.
- The node depends on the Surense OAuth2 API credentials configured in n8n.
- Pagination and sorting are handled internally by the node using the provided input properties.
- No additional external dependencies beyond the Surense API and its authentication.
Troubleshooting
Common issues:
- Invalid or missing 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 might lead to unexpected results or API errors.
- Network connectivity issues can prevent successful API calls.
Error messages:
- Authentication errors usually indicate problems with the API key or OAuth token; verify credentials.
- Validation errors related to input parameters suggest checking the "Order", "Order By", "Limit", and "Page" values.
- API rate limiting or quota exceeded errors require waiting or adjusting usage patterns.
Links and References
- Surense API Documentation (hypothetical link, replace with actual if available)
- n8n documentation on Creating Custom Nodes
- OAuth2 authentication setup in n8n: OAuth2 Credentials