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
Workflow → Search Workflows
AI-generatedOverview
This node integrates with the Surense API to perform various operations on different resources, including workflows. Specifically, for the Workflow resource and the Search Workflows operation, it allows users to search through workflows stored in Surense based on sorting, pagination, and quick filter criteria. This is useful for automating retrieval of workflow data, filtering workflows by creation or update dates, and managing large sets of workflows efficiently.
Practical examples include:
- Retrieving the most recently updated workflows for review.
- Paginating through workflows sorted by creation date.
- Searching workflows by a quick filter term such as name or ID.
Properties
| Name | Meaning |
|---|---|
| Order | Sort order of results: ascending (asc) or descending (desc). |
| Order By | Field to sort by: creation date (createdDate) or last activity date (lastActivityDate). |
| Limit | Maximum number of workflow results to return (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 workflows quickly. |
Output
The node outputs an array of JSON objects representing workflows matching the search criteria. Each item corresponds to a workflow record retrieved from the Surense API. The exact structure depends on the API response but typically includes workflow metadata such as IDs, names, creation dates, statuses, and other relevant fields.
No binary data output is indicated.
Dependencies
- Requires an OAuth2 API credential for authenticating with the Surense API.
- The node relies on internal helper modules for operation execution and pagination.
- No additional external dependencies are explicitly required beyond the Surense API access.
Troubleshooting
Common issues:
- Authentication failures if the OAuth2 credential is not configured correctly.
- Invalid parameter values, e.g., setting
limitorpagebelow 1. - API rate limits or connectivity issues with the Surense service.
Error messages:
- Errors thrown during operation execution will be caught and can be output as error JSON if "Continue On Fail" is enabled.
- Typical errors may include invalid parameter errors or network/API errors.
Resolutions:
- Verify OAuth2 credentials and permissions.
- Ensure input parameters meet validation rules.
- Check network connectivity and Surense API status.
Links and References
- Surense API documentation (not provided here, but recommended to consult for detailed API behavior)
- n8n OAuth2 credential setup guides for configuring authentication tokens